Interface ServiceOptions

Options for service hosted in a manager.

interface ServiceOptions {
    get managerNumber(): number;
    get managerType(): number;
    get payloadEncryptionMode(): PayloadEncryptionMode;
    set payloadEncryptionMode(mode: PayloadEncryptionMode): void;
    get replica(): ServiceHostingReplica;
    get serviceHostingType(): ServiceHostingType;
    get serviceNameSuffix(): string;
    set serviceNameSuffix(suffix: string): void;
    resetPayloadEncryptionMode(): void;
    withGlobalService(): void;
    withManagerSpecificService(): void;
}

Hierarchy (View Summary)

ServiceDefinitionOptions
- ServiceOptions

Index

Accessors

managerNumber managerType payloadEncryptionMode replica serviceHostingType serviceNameSuffix

Methods

resetPayloadEncryptionMode withGlobalService withManagerSpecificService

Accessors

managerNumber

get managerNumber(): number
The number of the manager which is hosting the service.

Returns number
Remarks
The property is only relevant if the service is manager-specific.

Inherited from ServiceDefinitionOptions.managerNumber

managerType

get managerType(): number
The type of the manager which is hosting the service.

Returns number
Remarks
The property is only relevant if the service is manager-specific.

Inherited from ServiceDefinitionOptions.managerType

payloadEncryptionMode

get payloadEncryptionMode(): PayloadEncryptionMode
Gets the payload encryption mode for the service.

Returns PayloadEncryptionMode
Remarks
The payload encryption mode determines how the service encrypts its payloads. If not configured explicitly, the system default payload encryption mode is used.
set payloadEncryptionMode(mode: PayloadEncryptionMode): void
Sets the payload encryption mode for the service.
Parameters
- mode: PayloadEncryptionMode
  The payload encryption mode.
Returns void
Remarks
The payload encryption mode determines how the service encrypts its payloads. If not configured explicitly, the system default payload encryption mode is used.

replica

get replica(): ServiceHostingReplica
The replica of the manager which is hosting the service.

Returns ServiceHostingReplica
Remarks
The replica is only relevant for manager-specific services hosted in non-redundant managers in redundant projects.

Inherited from ServiceDefinitionOptions.replica

serviceHostingType

get serviceHostingType(): ServiceHostingType
The hosting type of the service.

Returns ServiceHostingType
Remarks
Determines how the service is hosted (e.g. global or manager-specific).

Inherited from ServiceDefinitionOptions.serviceHostingType

serviceNameSuffix

get serviceNameSuffix(): string
The suffix appended to the service name.

Returns string
Remarks
The service name suffix is appended to the service base name to create a unique service full name. Default is an empty string.
set serviceNameSuffix(suffix: string): void
Sets the suffix appended to the service name.
Parameters
- suffix: string
Returns void
Remarks
The service name suffix is appended to the service base name to create a unique service full name. Default is an empty string.

Methods

resetPayloadEncryptionMode

resetPayloadEncryptionMode(): void
Resets the payload encryption mode to system default.

Returns void

withGlobalService

withGlobalService(): void
Host service as a global service.

Returns void

withManagerSpecificService

withManagerSpecificService(): void
Host service as manager-specific service.

Returns void