Package io.camunda.client.api.search.response

Interface CorrelatedMessageSubscription

All Known Implementing Classes:
CorrelatedMessageSubscriptionImpl
public interface CorrelatedMessageSubscription

  • Method Details

    • getCorrelationKey

      String getCorrelationKey()

    • getCorrelationTime

      OffsetDateTime getCorrelationTime()

    • getElementId

      String getElementId()

    • getElementInstanceKey

      Long getElementInstanceKey()

    • getMessageKey

      Long getMessageKey()

    • getMessageName

      String getMessageName()

    • getPartitionId

      Integer getPartitionId()

    • getProcessDefinitionId

      String getProcessDefinitionId()

    • getProcessDefinitionKey

      Long getProcessDefinitionKey()

    • getProcessInstanceKey

      Long getProcessInstanceKey()

    • getRootProcessInstanceKey

      Long getRootProcessInstanceKey()
      Returns the key of the root process instance. The root process instance is the top-level ancestor in the process instance hierarchy.

      Note: This field is null for process instance hierarchies created before version 8.9.

      Returns:
      the root process instance key, or null for data created before version 8.9

    • getSubscriptionKey

      Long getSubscriptionKey()

    • getTenantId

      String getTenantId()

    • getBusinessId

      String getBusinessId()
      Returns the business id associated with this correlated message subscription.

      For a message start event correlation, this is the business id carried by the correlating message, which was stamped on the started process instance to enforce its uniqueness. For a catch, boundary, or intermediate event correlation, this is the business id of the subscribing process instance, captured when the subscription was opened.

      Note: This field is null when the relevant process instance has no business id.

      Returns:
      the business id, or null if none applies