Axinom Mosaic Libraries
    Preparing search index...

    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 (View Summary)

    Index

    Properties

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

    Methods

    getEnvironmentRoutingKey toString

    Properties

    action: "event" | "command"

    If the message is a command or an event

    aggregateType: string

    Aggregated root type of the message

    messageType: string

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

    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

    routingKey: string

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

    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).

    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".

    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".

    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".

    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.

    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.

    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.

    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.

    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".

    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.

    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".

    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.

    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.

    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.

    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.

    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".

    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".

    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

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

      Parameters

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

      Returns string

    • Returns string

    Settings

    Member Visibility

    On This Page

    Properties
    Methods