Properties

Link copied to clipboard
abstract val aggregateId: AggregateId

The aggregate ID used to uniquely identify an aggregate instance.

Link copied to clipboard
abstract val aggregateName: String

The name of the aggregate.

Link copied to clipboard
abstract val body: T

The typed payload of the message.

Link copied to clipboard
abstract val commandId: String

A unique identifier for this command instance.

Link copied to clipboard
abstract val contextName: String

The name of the bounded context this entity belongs to.

Link copied to clipboard
abstract override val createTime: Long

The timestamp when this message was created, as a Unix timestamp in milliseconds.

Link copied to clipboard
abstract val header: Header

The header containing metadata about this message.

Link copied to clipboard
abstract val id: String

Represents a unique identifier for the implementing entity.

Link copied to clipboard

A computed property that indicates whether the entity has been initialized. Returns true if the version is greater than UNINITIALIZED_VERSION. This property is ignored during JSON serialization.

Link copied to clipboard

A computed property that indicates whether the entity is at its initial version. Returns true if the version equals INITIAL_VERSION. This property is ignored during JSON serialization.

Link copied to clipboard

Indicates whether this message is in read-only mode.

Link copied to clipboard
abstract val ownerId: String

The unique identifier of the resource owner.

Link copied to clipboard
abstract val version: Int

The current version number of the entity as an integer. Versions are monotonically increasing and start from 1 for initialized entities. A version of 0 indicates an uninitialized state.

Functions

Link copied to clipboard

Checks if two aggregates belong to the same context and have the same aggregate name.

Link copied to clipboard

Checks if this entity belongs to the same bounded context as another entity.

Link copied to clipboard
open fun withHeader(additionalSource: Map<String, String>): SOURCE

Adds all key-value pairs from the provided map to the message header and returns the message for method chaining.

open fun withHeader(key: String, value: String): SOURCE

Adds a key-value pair to the message header and returns the message for method chaining.

Link copied to clipboard
open fun withReadOnly(): SOURCE

Marks this message as read-only and returns it for method chaining.