Skip to main content

Interface: $Properties

v1.Message.$Properties

Properties of a Message.

Hierarchy​

Properties​

body​

• Optional body: null | $Properties

The opaque data carried by this message. The protocol type can be extracted from the package name of the message carried inside the Any.


commandIndex​

• Optional commandIndex: null | Long

Message commandIndex


eventId​

• Optional eventId: null | Long

Message eventId


id​

• Optional id: null | string

An ID for this specific message.


protocolInstanceId​

• Optional protocolInstanceId: null | string

Identifies the specific instance of a protocol to which this message belongs.


sequencingId​

• Optional sequencingId: "eventId" | "commandIndex"

The event ID or command ID after which this message can be delivered. The effects of history up to and including this event ID should be visible to the code that handles this message. Omit to opt out of sequencing.