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

Interface ProcessInstanceRecordValue

All Superinterfaces:
JsonSerializable, ProcessInstanceRelated, RecordValue, TenantOwned
All Known Implementing Classes:
ImmutableProcessInstanceRecordValue
@Immutable public interface ProcessInstanceRecordValue extends RecordValue, ProcessInstanceRelated, TenantOwned
Represents a process instance related command or event.

See ProcessInstanceIntent for intents.

  • Method Details

    • getBpmnProcessId

      String getBpmnProcessId()
      Returns:
      the BPMN process id this process instance belongs to.

    • getVersion

      int getVersion()
      Returns:
      the version of the deployed process this instance belongs to.

    • getProcessDefinitionKey

      long getProcessDefinitionKey()
      Returns:
      the key of the deployed process this instance belongs to.

    • getProcessInstanceKey

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

    • getElementId

      String getElementId()
      Returns:
      the id of the current process element, or empty if the id is not specified.

    • getFlowScopeKey

      long getFlowScopeKey()
      Returns:
      the key of the activity instance that is the flow scope of this flow element instance; -1 for records of the process instance itself.

    • getBpmnElementType

      BpmnElementType getBpmnElementType()
      Returns:
      the BPMN type of the current process element.

    • getParentProcessInstanceKey

      long getParentProcessInstanceKey()
      Returns:
      the key of the process instance that created this instance, or -1 if it was not created by another process instance.

    • getParentElementInstanceKey

      long getParentElementInstanceKey()
      Returns:
      the key of the element instance that created this instance, or -1 if it was not created by another process instance.

    • getBpmnEventType

      BpmnEventType getBpmnEventType()
      Returns:
      the BPMN event type of the current process element.