Package io.camunda.zeebe.protocol.record.value

Interface MessageRecordValue

All Superinterfaces:

JsonSerializable, RecordValue, RecordValueWithVariables

All Known Implementing Classes:

ImmutableMessageRecordValue

@Immutable
public interface MessageRecordValue
extends RecordValueWithVariables

Represents a message event or command.

See MessageIntent for intents.

Method Summary

Modifier and Type	Method	Description
String	getCorrelationKey()
long	getDeadline()
String	getMessageId()	The ID of a message is an optional field which is used to make messages unique and prevent publishing the same message twice during its lifetime.
String	getName()
long	getTimeToLive()

Methods inherited from interface io.camunda.zeebe.protocol.record.JsonSerializable

toJson

Methods inherited from interface io.camunda.zeebe.protocol.record.RecordValueWithVariables

getVariables

Method Details

getName

String getName()

Returns:

the name of the message

getCorrelationKey

String getCorrelationKey()

Returns:

the correlation key of the message

getMessageId

String getMessageId()

The ID of a message is an optional field which is used to make messages unique and prevent publishing the same message twice during its lifetime.

Returns:

the id of the message

getTimeToLive

long getTimeToLive()

Returns:

the time to live of the message

getDeadline

long getDeadline()

Returns:

the unix timestamp in milliseconds until when the message can be correlated. If the deadline is exceeded then the message expires and will be removed. If this property is not set, it returns -1 instead.