Class VideoServiceMultiTenantMessagingSettings

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

MultiTenantMessagingSettings
- VideoServiceMultiTenantMessagingSettings

Constructors

`Private` constructor

new VideoServiceMultiTenantMessagingSettings(messageType, queue, routingKey, action, aggregateType): VideoServiceMultiTenantMessagingSettings
Parameters
- messageType: string
- queue: string
- routingKey: string
- action: "event" | "command"
- aggregateType: string
Returns VideoServiceMultiTenantMessagingSettings

Overrides MultiTenantMessagingSettings.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` ArchiveVideos

ArchiveVideos: VideoServiceMultiTenantMessagingSettings = ...

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

`Static` ArchiveVideosFailed

ArchiveVideosFailed: VideoServiceMultiTenantMessagingSettings = ...

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

`Static` ArchiveVideosFinished

ArchiveVideosFinished: VideoServiceMultiTenantMessagingSettings = ...

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

`Static` CuePointTypesDeclareFailed

CuePointTypesDeclareFailed: VideoServiceMultiTenantMessagingSettings = ...

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

`Static` CuePointTypesDeclared

CuePointTypesDeclared: VideoServiceMultiTenantMessagingSettings = ...

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

`Static` DeclareCuePointTypes

DeclareCuePointTypes: VideoServiceMultiTenantMessagingSettings = ...

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

`Static` DeleteVideo

DeleteVideo: VideoServiceMultiTenantMessagingSettings = ...

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

`Static` DeleteVideoFailed

DeleteVideoFailed: VideoServiceMultiTenantMessagingSettings = ...

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

`Static` DeleteVideoFinished

DeleteVideoFinished: VideoServiceMultiTenantMessagingSettings = ...

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

`Static` EnsureVideoExists

EnsureVideoExists: VideoServiceMultiTenantMessagingSettings = ...

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

`Static` EnsureVideoExistsAlreadyExisted

EnsureVideoExistsAlreadyExisted: VideoServiceMultiTenantMessagingSettings = ...

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

`Static` EnsureVideoExistsCreationStarted

EnsureVideoExistsCreationStarted: VideoServiceMultiTenantMessagingSettings = ...

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

`Static` EnsureVideoExistsFailed

EnsureVideoExistsFailed: VideoServiceMultiTenantMessagingSettings = ...

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

`Static` ImportCustomVideo

ImportCustomVideo: VideoServiceMultiTenantMessagingSettings = ...

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

`Static` ImportCustomVideoFailed

ImportCustomVideoFailed: VideoServiceMultiTenantMessagingSettings = ...

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

`Static` ImportCustomVideoFinished

ImportCustomVideoFinished: VideoServiceMultiTenantMessagingSettings = ...

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

`Static` StartVideosDeletion

StartVideosDeletion: VideoServiceMultiTenantMessagingSettings = ...

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

`Static` UnarchiveVideos

UnarchiveVideos: VideoServiceMultiTenantMessagingSettings = ...

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

`Static` UnarchiveVideosFailed

UnarchiveVideosFailed: VideoServiceMultiTenantMessagingSettings = ...

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

`Static` UnarchiveVideosFinished

UnarchiveVideosFinished: VideoServiceMultiTenantMessagingSettings = ...

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

`Static` VideoEncodingFailed

VideoEncodingFailed: VideoServiceMultiTenantMessagingSettings = ...

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

`Static` VideoEncodingFinished

VideoEncodingFinished: VideoServiceMultiTenantMessagingSettings = ...

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

Methods

getEnvironmentRoutingKey

getEnvironmentRoutingKey(environmentInfo): string
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

Inherited from MultiTenantMessagingSettings.getEnvironmentRoutingKey

toString

toString(): string
Returns string

Class VideoServiceMultiTenantMessagingSettings

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Private constructor

Parameters

messageType: string

queue: string

routingKey: string

action: "event" | "command"

aggregateType: string

Returns VideoServiceMultiTenantMessagingSettings

Properties

Readonly action

Readonly aggregateType

Readonly messageType

Readonly queue

Readonly routingKey

Readonly serviceId

Static ArchiveVideos

Static ArchiveVideosFailed

Static ArchiveVideosFinished

Static CuePointTypesDeclareFailed

Static CuePointTypesDeclared

Static DeclareCuePointTypes

Static DeleteVideo

Static DeleteVideoFailed

Static DeleteVideoFinished

Static EnsureVideoExists

Static EnsureVideoExistsAlreadyExisted

Static EnsureVideoExistsCreationStarted

Static EnsureVideoExistsFailed

Static ImportCustomVideo

Static ImportCustomVideoFailed

Static ImportCustomVideoFinished

Static StartVideosDeletion

Static UnarchiveVideos

Static UnarchiveVideosFailed

Static UnarchiveVideosFinished

Static VideoEncodingFailed

Static VideoEncodingFinished

Methods

getEnvironmentRoutingKey

Parameters

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

environmentId: string

tenantId: string

Returns string

toString

Returns string

Settings

Member Visibility

Theme

On This Page

`Private` constructor

`Readonly` action

`Readonly` aggregateType

`Readonly` messageType

`Readonly` queue

`Readonly` routingKey

`Readonly` serviceId

`Static` ArchiveVideos

`Static` ArchiveVideosFailed

`Static` ArchiveVideosFinished

`Static` CuePointTypesDeclareFailed

`Static` CuePointTypesDeclared

`Static` DeclareCuePointTypes

`Static` DeleteVideo

`Static` DeleteVideoFailed

`Static` DeleteVideoFinished

`Static` EnsureVideoExists

`Static` EnsureVideoExistsAlreadyExisted

`Static` EnsureVideoExistsCreationStarted

`Static` EnsureVideoExistsFailed

`Static` ImportCustomVideo

`Static` ImportCustomVideoFailed

`Static` ImportCustomVideoFinished

`Static` StartVideosDeletion

`Static` UnarchiveVideos

`Static` UnarchiveVideosFailed

`Static` UnarchiveVideosFinished

`Static` VideoEncodingFailed

`Static` VideoEncodingFinished

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