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

Interface ProcessInstanceBatchRecordValue

All Superinterfaces:
JsonSerializable, ProcessInstanceRelated, RecordValue
All Known Implementing Classes:
ImmutableProcessInstanceBatchRecordValue
@Immutable public interface ProcessInstanceBatchRecordValue extends RecordValue, ProcessInstanceRelated
Represents a batch action that's performed for a process instance. An example for this is termination of child instances. Instead of writing a TERMINATE command for all children, this command is used to batch these commands in smaller chunks.

  • Method Details

    • getBatchElementInstanceKey

      long getBatchElementInstanceKey()
      Returns:
      the element instance for which a batch action is being performed. This should be a container element (e.g. a subprocess).

    • getIndex

      long getIndex()
      Returns:
      an index used to keep track of where we are in our batch process and where to start the next batch.