Package io.camunda.zeebe.process.test.inspections

Class ProcessInstanceInspections

java.lang.Object

io.camunda.zeebe.process.test.inspections.ProcessInstanceInspections

public class ProcessInstanceInspections
extends Object

Inspections for process instance events. This class is particularly useful to find process instances that have been started by other process instances (e.g. by a call activity).

Constructor Summary

Constructors

Constructor	Description
ProcessInstanceInspections(ProcessInstanceRecordStreamFilter filter)

Method Summary

Modifier and Type	Method	Description
Optional<InspectedProcessInstance>	findFirstProcessInstance()	Finds the first process instance that matches the applied filters
Optional<InspectedProcessInstance>	findLastProcessInstance()	Finds the last process instance that matches the applied filters
Optional<InspectedProcessInstance>	findProcessInstance(int index)	Finds the process instance that matches the applied filters at a given index
ProcessInstanceInspections	withBpmnProcessId(String bpmnProcessId)	Filters the process instances to only include instances that have the given BPMN process id
ProcessInstanceInspections	withParentProcessInstanceKey(long key)	Filters the process instances to only include instances that were started by the given parent process instance key

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ProcessInstanceInspections

public ProcessInstanceInspections(ProcessInstanceRecordStreamFilter filter)

Method Details

withParentProcessInstanceKey

public ProcessInstanceInspections withParentProcessInstanceKey(long key)

Filters the process instances to only include instances that were started by the given parent process instance key

Parameters:

key - The key of the parent process instance

Returns:

this ProcessInstanceInspections

withBpmnProcessId

public ProcessInstanceInspections withBpmnProcessId(String bpmnProcessId)

Filters the process instances to only include instances that have the given BPMN process id

Parameters:

bpmnProcessId - The BPMN process id of the desired process instance

Returns:

this ProcessInstanceInspections

findFirstProcessInstance

public Optional<InspectedProcessInstance> findFirstProcessInstance()

Finds the first process instance that matches the applied filters

Returns:

Optional of InspectedProcessInstance

findLastProcessInstance

public Optional<InspectedProcessInstance> findLastProcessInstance()

Finds the last process instance that matches the applied filters

Returns:

Optional of InspectedProcessInstance

findProcessInstance

public Optional<InspectedProcessInstance> findProcessInstance(int index)

Finds the process instance that matches the applied filters at a given index

Example: If 3 process instances have been started, findProcessInstance(1) would return the second started instance.

Parameters:

index - The index of the process instance start at 0

Returns:

Optional of InspectedProcessInstance