Package io.zeebe.protocol.record.value
Interface MessageRecordValue
-
- All Superinterfaces:
JsonSerializable,RecordValue,RecordValueWithVariables
public interface MessageRecordValue extends RecordValueWithVariables
Represents a message event or command.See
MessageIntentfor intents.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetCorrelationKey()longgetDeadline()StringgetMessageId()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.StringgetName()longgetTimeToLive()-
Methods inherited from interface io.zeebe.protocol.record.JsonSerializable
toJson
-
Methods inherited from interface io.zeebe.protocol.record.RecordValueWithVariables
getVariables
-
-
-
-
Method Detail
-
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.
-
-