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

Interface ProcessInstanceModificationRecordValue

All Superinterfaces:

JsonSerializable, ProcessInstanceRelated, RecordValue, TenantOwned

All Known Implementing Classes:

ImmutableProcessInstanceModificationRecordValue

@Immutable
public interface ProcessInstanceModificationRecordValue
extends RecordValue, ProcessInstanceRelated, TenantOwned

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ProcessInstanceModificationRecordValue.ProcessInstanceModificationActivateInstructionValue
static interface	ProcessInstanceModificationRecordValue.ProcessInstanceModificationTerminateInstructionValue
static interface	ProcessInstanceModificationRecordValue.ProcessInstanceModificationVariableInstructionValue

Field Summary

Fields inherited from interface io.camunda.zeebe.protocol.record.value.TenantOwned

DEFAULT_TENANT_IDENTIFIER

Method Summary

Modifier and Type	Method	Description
List<ProcessInstanceModificationRecordValue.ProcessInstanceModificationActivateInstructionValue>	getActivateInstructions()	Returns a list of activate instructions (if available), or an empty list.
Set<Long>	getAncestorScopeKeys()	Deprecated. since 8.1.3, replaced by ProcessInstanceModificationRecordValue.ProcessInstanceModificationActivateInstructionValue.getAncestorScopeKeys()
List<ProcessInstanceModificationRecordValue.ProcessInstanceModificationTerminateInstructionValue>	getTerminateInstructions()	Returns a list of terminate instructions (if available), or an empty list.

Methods inherited from interface io.camunda.zeebe.protocol.record.JsonSerializable

toJson

Methods inherited from interface io.camunda.zeebe.protocol.record.value.ProcessInstanceRelated

getProcessInstanceKey

Methods inherited from interface io.camunda.zeebe.protocol.record.value.TenantOwned

getTenantId

Method Details

getTerminateInstructions

List<ProcessInstanceModificationRecordValue.ProcessInstanceModificationTerminateInstructionValue> getTerminateInstructions()

Returns a list of terminate instructions (if available), or an empty list.

getActivateInstructions

List<ProcessInstanceModificationRecordValue.ProcessInstanceModificationActivateInstructionValue> getActivateInstructions()

Returns a list of activate instructions (if available), or an empty list.

getAncestorScopeKeys

@Deprecated
Set<Long> getAncestorScopeKeys()

Deprecated.

since 8.1.3, replaced by ProcessInstanceModificationRecordValue.ProcessInstanceModificationActivateInstructionValue.getAncestorScopeKeys()

Returns a list of all ancestor keys of all activate instructions. The property is set in the event only after the modification is applied.