@axinom/mosaic-messages 0.44.0-rc.1 → 0.44.0-rc.3

package/src/generated/config/payloads/video/video-service-multi-tenant-messaging-settings.ts

@@ -1,6 +1,11 @@
 import { MultiTenantMessagingSettings } from '@axinom/mosaic-message-bus-abstractions';
 
 export class VideoServiceMultiTenantMessagingSettings extends MultiTenantMessagingSettings {
+  /**
+   * 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.
+   */
   public static DeclareCuePointTypes = new VideoServiceMultiTenantMessagingSettings(
     'DeclareCuePointTypes', 
     'inbox', 
@@ -8,6 +13,11 @@ export class VideoServiceMultiTenantMessagingSettings extends MultiTenantMessagi
     'command',
     'cue-point-type'
     );
+  /**
+   * 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".
+   */
   public static EnsureVideoExists = new VideoServiceMultiTenantMessagingSettings(
     'EnsureVideoExists', 
     'inbox', 
@@ -15,6 +25,11 @@ export class VideoServiceMultiTenantMessagingSettings extends MultiTenantMessagi
     'command',
     'video'
     );
+  /**
+   * 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".
+   */
   public static ArchiveVideos = new VideoServiceMultiTenantMessagingSettings(
     'ArchiveVideos', 
     'inbox', 
@@ -22,6 +37,11 @@ export class VideoServiceMultiTenantMessagingSettings extends MultiTenantMessagi
     'command',
     'video'
     );
+  /**
+   * 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".
+   */
   public static UnarchiveVideos = new VideoServiceMultiTenantMessagingSettings(
     'UnarchiveVideos', 
     'inbox', 
@@ -29,6 +49,11 @@ export class VideoServiceMultiTenantMessagingSettings extends MultiTenantMessagi
     'command',
     'video'
     );
+  /**
+   * 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".
+   */
   public static ImportCustomVideo = new VideoServiceMultiTenantMessagingSettings(
     'ImportCustomVideo', 
     'inbox', 
@@ -36,6 +61,11 @@ export class VideoServiceMultiTenantMessagingSettings extends MultiTenantMessagi
     'command',
     'video'
     );
+  /**
+   * 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.
+   */
   public static CuePointTypesDeclared = new VideoServiceMultiTenantMessagingSettings(
     'CuePointTypesDeclared', 
     'cue_point_types:declared', 
@@ -43,6 +73,11 @@ export class VideoServiceMultiTenantMessagingSettings extends MultiTenantMessagi
     'event',
     'cue-point-type'
     );
+  /**
+   * 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.
+   */
   public static CuePointTypesDeclareFailed = new VideoServiceMultiTenantMessagingSettings(
     'CuePointTypesDeclareFailed', 
     'cue_point_types:declare_failed', 
@@ -50,6 +85,11 @@ export class VideoServiceMultiTenantMessagingSettings extends MultiTenantMessagi
     'event',
     'cue-point-type'
     );
+  /**
+   * 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.
+   */
   public static EnsureVideoExistsAlreadyExisted = new VideoServiceMultiTenantMessagingSettings(
     'EnsureVideoExistsAlreadyExisted', 
     'video:ensure_exists_already_existed', 
@@ -57,6 +97,11 @@ export class VideoServiceMultiTenantMessagingSettings extends MultiTenantMessagi
     'event',
     'video'
     );
+  /**
+   * 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.
+   */
   public static EnsureVideoExistsCreationStarted = new VideoServiceMultiTenantMessagingSettings(
     'EnsureVideoExistsCreationStarted', 
     'video:ensure_exists_creation_started', 
@@ -64,6 +109,11 @@ export class VideoServiceMultiTenantMessagingSettings extends MultiTenantMessagi
     'event',
     'video'
     );
+  /**
+   * 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".
+   */
   public static EnsureVideoExistsFailed = new VideoServiceMultiTenantMessagingSettings(
     'EnsureVideoExistsFailed', 
     'video:ensure_exists_failed', 
@@ -71,6 +121,11 @@ export class VideoServiceMultiTenantMessagingSettings extends MultiTenantMessagi
     'event',
     'video'
     );
+  /**
+   * 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".
+   */
   public static ArchiveVideosFinished = new VideoServiceMultiTenantMessagingSettings(
     'ArchiveVideosFinished', 
     'videos:archive_finished', 
@@ -78,6 +133,11 @@ export class VideoServiceMultiTenantMessagingSettings extends MultiTenantMessagi
     'event',
     'video'
     );
+  /**
+   * 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".
+   */
   public static ArchiveVideosFailed = new VideoServiceMultiTenantMessagingSettings(
     'ArchiveVideosFailed', 
     'videos:archive_failed', 
@@ -85,6 +145,11 @@ export class VideoServiceMultiTenantMessagingSettings extends MultiTenantMessagi
     'event',
     'video'
     );
+  /**
+   * 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".
+   */
   public static UnarchiveVideosFinished = new VideoServiceMultiTenantMessagingSettings(
     'UnarchiveVideosFinished', 
     'videos:unarchive_finished', 
@@ -92,6 +157,11 @@ export class VideoServiceMultiTenantMessagingSettings extends MultiTenantMessagi
     'event',
     'video'
     );
+  /**
+   * 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".
+   */
   public static UnarchiveVideosFailed = new VideoServiceMultiTenantMessagingSettings(
     'UnarchiveVideosFailed', 
     'videos:unarchive_failed', 
@@ -99,6 +169,11 @@ export class VideoServiceMultiTenantMessagingSettings extends MultiTenantMessagi
     'event',
     'video'
     );
+  /**
+   * 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.
+   */
   public static ImportCustomVideoFinished = new VideoServiceMultiTenantMessagingSettings(
     'ImportCustomVideoFinished', 
     'custom_video:import_finished', 
@@ -106,6 +181,11 @@ export class VideoServiceMultiTenantMessagingSettings extends MultiTenantMessagi
     'event',
     'video'
     );
+  /**
+   * 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".
+   */
   public static ImportCustomVideoFailed = new VideoServiceMultiTenantMessagingSettings(
     'ImportCustomVideoFailed', 
     'custom_video:import_failed', 
@@ -113,6 +193,11 @@ export class VideoServiceMultiTenantMessagingSettings extends MultiTenantMessagi
     'event',
     'video'
     );
+  /**
+   * 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.
+   */
   public static VideoEncodingFinished = new VideoServiceMultiTenantMessagingSettings(
     'VideoEncodingFinished', 
     'video:encoding_finished', 
@@ -120,6 +205,11 @@ export class VideoServiceMultiTenantMessagingSettings extends MultiTenantMessagi
     'event',
     'video'
     );
+  /**
+   * 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.
+   */
   public static VideoEncodingFailed = new VideoServiceMultiTenantMessagingSettings(
     'VideoEncodingFailed', 
     'video:encoding_failed',