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

Class ProcessEventInspections

java.lang.Object

io.camunda.zeebe.process.test.inspections.ProcessEventInspections

public class ProcessEventInspections
extends Object

Inspections for process events. This class is particularly useful to find processes that have been started without manually triggering them (e.g. with a timer start event).

Constructor Summary

Constructors

Constructor	Description
ProcessEventInspections(ProcessEventRecordStreamFilter 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
ProcessEventInspections	triggeredByTimer(String timerId)	Filters the process instances to only include instances that were triggered by a given timer event id
ProcessEventInspections	withProcessDefinitionKey(long processDefinitionKey)	Filters the process instances to only include instance with a given process definition key

Methods inherited from class java.lang.Object

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

Constructor Details

ProcessEventInspections

public ProcessEventInspections(ProcessEventRecordStreamFilter filter)

Method Details

triggeredByTimer

public ProcessEventInspections triggeredByTimer(String timerId)

Filters the process instances to only include instances that were triggered by a given timer event id

Parameters:

timerId - The element ID of the timer event

Returns:

this ProcessEventInspections

withProcessDefinitionKey

public ProcessEventInspections withProcessDefinitionKey(long processDefinitionKey)

Filters the process instances to only include instance with a given process definition key

Parameters:

processDefinitionKey - The process definition key

Returns:

this ProcessEventInspections

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