Package io.zeebe.protocol.record.value
Interface MessageStartEventSubscriptionRecordValue
-
- All Superinterfaces:
JsonSerializable,RecordValue,RecordValueWithVariables
public interface MessageStartEventSubscriptionRecordValue extends RecordValueWithVariables
Represents message start event subscription commands and eventsSee
MessageStartEventSubscriptionIntentfor intents.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetBpmnProcessId()StringgetCorrelationKey()longgetMessageKey()StringgetMessageName()longgetProcessDefinitionKey()longgetProcessInstanceKey()StringgetStartEventId()-
Methods inherited from interface io.zeebe.protocol.record.JsonSerializable
toJson
-
Methods inherited from interface io.zeebe.protocol.record.RecordValueWithVariables
getVariables
-
-
-
-
Method Detail
-
getProcessDefinitionKey
long getProcessDefinitionKey()
- Returns:
- the process key tied to the subscription
-
getBpmnProcessId
String getBpmnProcessId()
- Returns:
- the BPMN process id tied to the subscription
-
getStartEventId
String getStartEventId()
- Returns:
- the id of the start event tied to the subscription
-
getMessageName
String getMessageName()
- Returns:
- the name of the message
-
getProcessInstanceKey
long getProcessInstanceKey()
- Returns:
- the key of the process instance that was created by this message. It is only set when a message is correlated to this subscription. Otherwise, it returns -1.
-
getCorrelationKey
String getCorrelationKey()
- Returns:
- the correlation key of the message. It is only set when a message is correlated to this subscription. Otherwise, it returns an empty string.
-
getMessageKey
long getMessageKey()
- Returns:
- the key of the message. It is only set when a message is correlated to this subscription. Otherwise, it returns -1.
-
-