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

Interface MessageSubscriptionRecordValue

All Superinterfaces:
JsonSerializable, ProcessInstanceRelated, RecordValue, RecordValueWithVariables, TenantOwned
All Known Implementing Classes:
ImmutableMessageSubscriptionRecordValue
@Immutable public interface MessageSubscriptionRecordValue extends RecordValueWithVariables, ProcessInstanceRelated, TenantOwned
Represents a message correlation subscription event or command.

See MessageSubscriptionIntent for intents.

  • Method Details

    • getProcessInstanceKey

      long getProcessInstanceKey()
      Specified by:
      getProcessInstanceKey in interface ProcessInstanceRelated
      Returns:
      the process instance key tied to the subscription

    • getElementInstanceKey

      long getElementInstanceKey()
      Returns:
      the element instance key tied to the subscription

    • getBpmnProcessId

      String getBpmnProcessId()
      Returns:
      the BPMN process id tied to the subscription

    • getMessageName

      String getMessageName()
      Returns:
      the name of the message

    • getCorrelationKey

      String getCorrelationKey()
      Returns:
      the correlation key

    • getMessageKey

      long getMessageKey()
      Returns:
      the key of the correlated message

    • isInterrupting

      boolean isInterrupting()
      Returns:
      true if the event tied to the subscription is interrupting. Otherwise, it returns false if the event is non-interrupting.