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

Interface ProcessMessageSubscriptionRecordValue

All Superinterfaces:
JsonSerializable, ProcessInstanceRelated, RecordValue, RecordValueWithVariables
All Known Implementing Classes:
ImmutableProcessMessageSubscriptionRecordValue
@Immutable public interface ProcessMessageSubscriptionRecordValue extends RecordValueWithVariables, ProcessInstanceRelated
Represents a process message subscription command or event.

See ProcessMessageSubscriptionIntent for intents.

  • Method Details

    • getProcessInstanceKey

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

    • getElementInstanceKey

      long getElementInstanceKey()
      Returns:
      the element instance key

    • getBpmnProcessId

      String getBpmnProcessId()
      Returns:
      the BPMN process id

    • getMessageKey

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

    • getMessageName

      String getMessageName()
      Returns:
      the message name

    • getCorrelationKey

      String getCorrelationKey()
      Returns:
      the correlation key

    • getElementId

      String getElementId()
      Returns:
      the id of the element tied to the subscription.

    • isInterrupting

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