Class ImageServiceMultiTenantMessagingSettings

An interface that represents a messaging settings object for multitenant Managed services. Used to build Rascal config using RascalConfigBuilder to be used by a messaging broker.

Hierarchy

Constructors

constructor

Properties

action aggregateType messageType queue routingKey serviceId ArchiveImages ArchiveImagesFailed ArchiveImagesFinished DeclareImageTypes DeleteImage DeleteImageFailed DeleteImageFinished EnsureImageExists EnsureImageExistsAlreadyExisted EnsureImageExistsFailed EnsureImageExistsImageCreated ImageTypesDeclareFailed ImageTypesDeclared StartImagesDeletion UnarchiveImages UnarchiveImagesFailed UnarchiveImagesFinished

Methods

getEnvironmentRoutingKey toString

Constructors

Private constructor

Properties

Readonly action

action: "event" | "command"

If the message is a command or an event

Readonly aggregateType

aggregateType: string

Aggregated root type of the message

Readonly messageType

messageType: string

Unique key that is used by rascal. For convenience it usually resembles the name of the message.

Readonly queue

queue: string

Name of the queue which will receive messages of defined message type. RabbitMQ queue will be named using serviceId value and this value, e.g. service-id:queue

Readonly routingKey

routingKey: string

Routing key that is used to redirect messages from exchanges to queues

Readonly serviceId

serviceId: string

Optional service id value to be used during configuration. Represents destination service id, and not the origin one. If not specified, origin service id will be used (taken from MessagingConfig object).

Static ArchiveImages

ArchiveImages: ImageServiceMultiTenantMessagingSettings = ...

Defines the messaging settings for the command with message type "ArchiveImages" and aggregate type "image". There are multiple aggregate IDs in the payload so the field must contain the value "MULTIPLE_IDS".

Static ArchiveImagesFailed

ArchiveImagesFailed: ImageServiceMultiTenantMessagingSettings = ...

Defines the messaging settings for the event with message type "ArchiveImagesFailed" and aggregate type "image". There are multiple aggregate IDs in the payload so the field contains the value "MULTIPLE_IDS".

Static ArchiveImagesFinished

ArchiveImagesFinished: ImageServiceMultiTenantMessagingSettings = ...

Defines the messaging settings for the event with message type "ArchiveImagesFinished" and aggregate type "image". There are multiple aggregate IDs in the payload so the field contains the value "MULTIPLE_IDS".

Static DeclareImageTypes

DeclareImageTypes: ImageServiceMultiTenantMessagingSettings = ...

Defines the messaging settings for the command with message type "DeclareImageTypes" and aggregate type "image-type". The aggregate ID field must contain the value of the "environment ID" field.

Static DeleteImage

DeleteImage: ImageServiceMultiTenantMessagingSettings = ...

Defines the messaging settings for the command with message type "DeleteImage" and aggregate type "image". The aggregate ID field must contain the value of the "image ID" field.

Static DeleteImageFailed

DeleteImageFailed: ImageServiceMultiTenantMessagingSettings = ...

Defines the messaging settings for the event with message type "DeleteImageFailed" and aggregate type "image". The aggregate ID field contains the value of the "image ID" field.

Static DeleteImageFinished

DeleteImageFinished: ImageServiceMultiTenantMessagingSettings = ...

Defines the messaging settings for the event with message type "DeleteImageFinished" and aggregate type "image". The aggregate ID field contains the value of the "image ID" field.

Static EnsureImageExists

EnsureImageExists: ImageServiceMultiTenantMessagingSettings = ...

Defines the messaging settings for the command with message type "EnsureImageExists" and aggregate type "image". The aggregate ID is not known (yet) so the field must contain the value "UNDEFINED_ID".

Static EnsureImageExistsAlreadyExisted

EnsureImageExistsAlreadyExisted: ImageServiceMultiTenantMessagingSettings = ...

Defines the messaging settings for the event with message type "EnsureImageExistsAlreadyExisted" and aggregate type "image". The aggregate ID field contains the value of the "image ID" field.

Static EnsureImageExistsFailed

EnsureImageExistsFailed: ImageServiceMultiTenantMessagingSettings = ...

Defines the messaging settings for the event with message type "EnsureImageExistsFailed" and aggregate type "image". The aggregate ID is not known (yet) so the field contains the value "UNDEFINED_ID".

Static EnsureImageExistsImageCreated

EnsureImageExistsImageCreated: ImageServiceMultiTenantMessagingSettings = ...

Defines the messaging settings for the event with message type "EnsureImageExistsImageCreated" and aggregate type "image". The aggregate ID field contains the value of the "image ID" field.

Static ImageTypesDeclareFailed

ImageTypesDeclareFailed: ImageServiceMultiTenantMessagingSettings = ...

Defines the messaging settings for the event with message type "ImageTypesDeclareFailed" and aggregate type "image-type". The aggregate ID field contains the value of the "environment ID" field.

Static ImageTypesDeclared

ImageTypesDeclared: ImageServiceMultiTenantMessagingSettings = ...

Defines the messaging settings for the event with message type "ImageTypesDeclared" and aggregate type "image-type". The aggregate ID field contains the value of the "environment ID" field.

Static StartImagesDeletion

StartImagesDeletion: ImageServiceMultiTenantMessagingSettings = ...

Defines the messaging settings for the command with message type "StartImagesDeletion" and aggregate type "image". The aggregate ID field must contain the value of the "image ID" field.

Static UnarchiveImages

UnarchiveImages: ImageServiceMultiTenantMessagingSettings = ...

Defines the messaging settings for the command with message type "UnarchiveImages" and aggregate type "image". There are multiple aggregate IDs in the payload so the field must contain the value "MULTIPLE_IDS".

Static UnarchiveImagesFailed

UnarchiveImagesFailed: ImageServiceMultiTenantMessagingSettings = ...

Defines the messaging settings for the event with message type "UnarchiveImagesFailed" and aggregate type "image". There are multiple aggregate IDs in the payload so the field contains the value "MULTIPLE_IDS".

Static UnarchiveImagesFinished

UnarchiveImagesFinished: ImageServiceMultiTenantMessagingSettings = ...

Defines the messaging settings for the event with message type "UnarchiveImagesFinished" and aggregate type "image". There are multiple aggregate IDs in the payload so the field contains the value "MULTIPLE_IDS".

Methods

getEnvironmentRoutingKey

  • Returns a tenant and environment scoped routing key which can be used when publishing a multi-tenant message.

    Parameters

    • environmentInfo: {
          environmentId: string;
          tenantId: string;
      }
      • environmentId: string
      • tenantId: string

    Returns string

toString

  • Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc