Type Alias Service

type Service = {
    createServiceExportTemplate(): ServiceExportInterface;
    deleteFullService(
        serviceId: string,
        globalConfig?: boolean,
    ): Promise<AmServiceSkeleton>;
    deleteFullServices(globalConfig?: boolean): Promise<AmServiceSkeleton[]>;
    exportService(
        serviceId: string,
        globalConfig?: boolean,
    ): Promise<ServiceExportInterface>;
    exportServices(globalConfig?: boolean): Promise<ServiceExportInterface>;
    getFullServices(globalConfig?: boolean): Promise<FullService[]>;
    getListOfServices(globalConfig?: boolean): Promise<AmServiceSkeleton[]>;
    importService(
        serviceId: string,
        importData: ServiceExportInterface,
        options: ServiceImportOptions,
    ): Promise<AmServiceSkeleton>;
    importServices(
        importData: ServiceExportInterface,
        options: ServiceImportOptions,
    ): Promise<AmServiceSkeleton[]>;
}

Index

Methods

createServiceExportTemplate deleteFullService deleteFullServices exportService exportServices getFullServices getListOfServices importService importServices

Methods

createServiceExportTemplate

createServiceExportTemplate(): ServiceExportInterface
Returns ServiceExportInterface
- Defined in ops/ServiceOps.ts:27

deleteFullService

deleteFullService(
serviceId: string,
globalConfig?: boolean,
): Promise<AmServiceSkeleton>
Deletes the specified service
Parameters
- serviceId: string
  The service to delete
- OptionalglobalConfig: boolean
  true if the global service is the target of the operation, false otherwise. Default: false.
Returns Promise<AmServiceSkeleton>
- Defined in ops/ServiceOps.ts:46

deleteFullServices

deleteFullServices(globalConfig?: boolean): Promise<AmServiceSkeleton[]>
Deletes all services
Parameters
- OptionalglobalConfig: boolean
  true if the global service is the target of the operation, false otherwise. Default: false.
Returns Promise<AmServiceSkeleton[]>
- Defined in ops/ServiceOps.ts:54

exportService

exportService(
serviceId: string,
globalConfig?: boolean,
): Promise<ServiceExportInterface>
Export service. The response can be saved to file as is.
Parameters
- serviceId: string
  service id/name
- OptionalglobalConfig: boolean
  true if the global service is the target of the operation, false otherwise. Default: false.
Returns Promise<ServiceExportInterface>
Promise resolving to a ServiceExportInterface object.
- Defined in ops/ServiceOps.ts:61

exportServices

exportServices(globalConfig?: boolean): Promise<ServiceExportInterface>
Export all services
Parameters
- OptionalglobalConfig: boolean
  true if the global service is the target of the operation, false otherwise. Default: false.
Returns Promise<ServiceExportInterface>
- Defined in ops/ServiceOps.ts:69

getFullServices

getFullServices(globalConfig?: boolean): Promise<FullService[]>
Get all services including their descendents.
Parameters
- OptionalglobalConfig: boolean
  true if the global service is the target of the operation, false otherwise. Default: false.
Returns Promise<FullService[]>
Promise resolving to an array of services with their descendants
- Defined in ops/ServiceOps.ts:40

getListOfServices

getListOfServices(globalConfig?: boolean): Promise<AmServiceSkeleton[]>
Get list of services
Parameters
- OptionalglobalConfig: boolean
  true if the list of global services is requested, false otherwise. Default: false.
Returns Promise<AmServiceSkeleton[]>
- Defined in ops/ServiceOps.ts:32

importService

importService(
    serviceId: string,
    importData: ServiceExportInterface,
    options: ServiceImportOptions,
): Promise<AmServiceSkeleton>
Imports a single service using a reference to the service and a file to read the data from. Optionally clean (remove) an existing service first
Parameters
- serviceId: string
  The service id/name to add
- importData: ServiceExportInterface
  The service configuration export data to import
- options: ServiceImportOptions
  Import options
Returns Promise<AmServiceSkeleton>
A promise resolving to a service object
- Defined in ops/ServiceOps.ts:77

importServices

importServices(
importData: ServiceExportInterface,
options: ServiceImportOptions,
): Promise<AmServiceSkeleton[]>
Imports multiple services from the same file. Optionally clean (remove) existing services first
Parameters
- importData: ServiceExportInterface
  The service configuration export data to import
- options: ServiceImportOptions
  Import options
Returns Promise<AmServiceSkeleton[]>
A promise resolving to an array of service objects
- Defined in ops/ServiceOps.ts:88

Type Alias Service

Index

Methods

Methods

createServiceExportTemplate

Returns ServiceExportInterface

deleteFullService

Parameters

Returns Promise<AmServiceSkeleton>

deleteFullServices

Parameters

Returns Promise<AmServiceSkeleton[]>

exportService

Parameters

Returns Promise<ServiceExportInterface>

exportServices

Parameters

Returns Promise<ServiceExportInterface>

getFullServices

Parameters

Returns Promise<FullService[]>

getListOfServices

Parameters

Returns Promise<AmServiceSkeleton[]>

importService

Parameters

Returns Promise<AmServiceSkeleton>

importServices

Parameters

Returns Promise<AmServiceSkeleton[]>

Settings

On This Page