Package io.camunda.client.protocol.rest

Class ProcessInstanceFilter

java.lang.Object

io.camunda.client.protocol.rest.ProcessInstanceFilter

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2025-06-04T12:01:10.435788262Z[GMT]",
           comments="Generator version: 7.12.0")
public class ProcessInstanceFilter
extends Object

Process instance search filter.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_$_OR
static final String	JSON_PROPERTY_BATCH_OPERATION_ID
static final String	JSON_PROPERTY_ELEMENT_ID
static final String	JSON_PROPERTY_ELEMENT_INSTANCE_STATE
static final String	JSON_PROPERTY_END_DATE
static final String	JSON_PROPERTY_ERROR_MESSAGE
static final String	JSON_PROPERTY_HAS_ELEMENT_INSTANCE_INCIDENT
static final String	JSON_PROPERTY_HAS_INCIDENT
static final String	JSON_PROPERTY_HAS_RETRIES_LEFT
static final String	JSON_PROPERTY_INCIDENT_ERROR_HASH_CODE
static final String	JSON_PROPERTY_PARENT_ELEMENT_INSTANCE_KEY
static final String	JSON_PROPERTY_PARENT_PROCESS_INSTANCE_KEY
static final String	JSON_PROPERTY_PROCESS_DEFINITION_ID
static final String	JSON_PROPERTY_PROCESS_DEFINITION_KEY
static final String	JSON_PROPERTY_PROCESS_DEFINITION_NAME
static final String	JSON_PROPERTY_PROCESS_DEFINITION_VERSION
static final String	JSON_PROPERTY_PROCESS_DEFINITION_VERSION_TAG
static final String	JSON_PROPERTY_PROCESS_INSTANCE_KEY
static final String	JSON_PROPERTY_START_DATE
static final String	JSON_PROPERTY_STATE
static final String	JSON_PROPERTY_TENANT_ID
static final String	JSON_PROPERTY_VARIABLES

Constructor Summary

Constructors

Constructor	Description
ProcessInstanceFilter()

Method Summary

Modifier and Type	Method	Description
ProcessInstanceFilter	$or(List<ProcessInstanceFilterFields> $or)
ProcessInstanceFilter	add$OrItem(ProcessInstanceFilterFields $orItem)
ProcessInstanceFilter	addVariablesItem(VariableValueFilterRequest variablesItem)
ProcessInstanceFilter	batchOperationId(StringFilterProperty batchOperationId)
ProcessInstanceFilter	elementId(StringFilterProperty elementId)
ProcessInstanceFilter	elementInstanceState(ElementInstanceStateFilterProperty elementInstanceState)
ProcessInstanceFilter	endDate(DateTimeFilterProperty endDate)
boolean	equals(Object o)
ProcessInstanceFilter	errorMessage(StringFilterProperty errorMessage)
List<ProcessInstanceFilterFields>	get$Or()	Defines a list of alternative filter groups combined using OR logic.
StringFilterProperty	getBatchOperationId()	The batch operation ID.
StringFilterProperty	getElementId()	The element ID associated with the process instance.
ElementInstanceStateFilterProperty	getElementInstanceState()	The state of the element instances associated with the process instance.
DateTimeFilterProperty	getEndDate()	The end date.
StringFilterProperty	getErrorMessage()	The error message related to the process.
Boolean	getHasElementInstanceIncident()	Whether the element instance has an incident or not.
Boolean	getHasIncident()	Whether this process instance has a related incident or not.
Boolean	getHasRetriesLeft()	Whether the process has failed jobs with retries left.
Integer	getIncidentErrorHashCode()	The incident error hash code, associated with this process.
BasicStringFilterProperty	getParentElementInstanceKey()	The parent element instance key.
BasicStringFilterProperty	getParentProcessInstanceKey()	The parent process instance key.
StringFilterProperty	getProcessDefinitionId()	The process definition ID.
BasicStringFilterProperty	getProcessDefinitionKey()	The process definition key.
StringFilterProperty	getProcessDefinitionName()	The process definition name.
IntegerFilterProperty	getProcessDefinitionVersion()	The process definition version.
StringFilterProperty	getProcessDefinitionVersionTag()	The process definition version tag.
BasicStringFilterProperty	getProcessInstanceKey()	The key of this process instance.
DateTimeFilterProperty	getStartDate()	The start date.
ProcessInstanceStateFilterProperty	getState()	The process instance state.
StringFilterProperty	getTenantId()	The tenant ID.
List<VariableValueFilterRequest>	getVariables()	The process instance variables.
ProcessInstanceFilter	hasElementInstanceIncident(Boolean hasElementInstanceIncident)
int	hashCode()
ProcessInstanceFilter	hasIncident(Boolean hasIncident)
ProcessInstanceFilter	hasRetriesLeft(Boolean hasRetriesLeft)
ProcessInstanceFilter	incidentErrorHashCode(Integer incidentErrorHashCode)
ProcessInstanceFilter	parentElementInstanceKey(BasicStringFilterProperty parentElementInstanceKey)
ProcessInstanceFilter	parentProcessInstanceKey(BasicStringFilterProperty parentProcessInstanceKey)
ProcessInstanceFilter	processDefinitionId(StringFilterProperty processDefinitionId)
ProcessInstanceFilter	processDefinitionKey(BasicStringFilterProperty processDefinitionKey)
ProcessInstanceFilter	processDefinitionName(StringFilterProperty processDefinitionName)
ProcessInstanceFilter	processDefinitionVersion(IntegerFilterProperty processDefinitionVersion)
ProcessInstanceFilter	processDefinitionVersionTag(StringFilterProperty processDefinitionVersionTag)
ProcessInstanceFilter	processInstanceKey(BasicStringFilterProperty processInstanceKey)
void	set$Or(List<ProcessInstanceFilterFields> $or)
void	setBatchOperationId(StringFilterProperty batchOperationId)
void	setElementId(StringFilterProperty elementId)
void	setElementInstanceState(ElementInstanceStateFilterProperty elementInstanceState)
void	setEndDate(DateTimeFilterProperty endDate)
void	setErrorMessage(StringFilterProperty errorMessage)
void	setHasElementInstanceIncident(Boolean hasElementInstanceIncident)
void	setHasIncident(Boolean hasIncident)
void	setHasRetriesLeft(Boolean hasRetriesLeft)
void	setIncidentErrorHashCode(Integer incidentErrorHashCode)
void	setParentElementInstanceKey(BasicStringFilterProperty parentElementInstanceKey)
void	setParentProcessInstanceKey(BasicStringFilterProperty parentProcessInstanceKey)
void	setProcessDefinitionId(StringFilterProperty processDefinitionId)
void	setProcessDefinitionKey(BasicStringFilterProperty processDefinitionKey)
void	setProcessDefinitionName(StringFilterProperty processDefinitionName)
void	setProcessDefinitionVersion(IntegerFilterProperty processDefinitionVersion)
void	setProcessDefinitionVersionTag(StringFilterProperty processDefinitionVersionTag)
void	setProcessInstanceKey(BasicStringFilterProperty processInstanceKey)
void	setStartDate(DateTimeFilterProperty startDate)
void	setState(ProcessInstanceStateFilterProperty state)
void	setTenantId(StringFilterProperty tenantId)
void	setVariables(List<VariableValueFilterRequest> variables)
ProcessInstanceFilter	startDate(DateTimeFilterProperty startDate)
ProcessInstanceFilter	state(ProcessInstanceStateFilterProperty state)
ProcessInstanceFilter	tenantId(StringFilterProperty tenantId)
String	toString()
String	toUrlQueryString()	Convert the instance into URL query string.
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.
ProcessInstanceFilter	variables(List<VariableValueFilterRequest> variables)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

JSON_PROPERTY_PROCESS_DEFINITION_ID

public static final String JSON_PROPERTY_PROCESS_DEFINITION_ID

See Also:

• Constant Field Values

JSON_PROPERTY_PROCESS_DEFINITION_NAME

public static final String JSON_PROPERTY_PROCESS_DEFINITION_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_PROCESS_DEFINITION_VERSION

public static final String JSON_PROPERTY_PROCESS_DEFINITION_VERSION

See Also:

• Constant Field Values

JSON_PROPERTY_PROCESS_DEFINITION_VERSION_TAG

public static final String JSON_PROPERTY_PROCESS_DEFINITION_VERSION_TAG

See Also:

• Constant Field Values

JSON_PROPERTY_PROCESS_DEFINITION_KEY

public static final String JSON_PROPERTY_PROCESS_DEFINITION_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_START_DATE

public static final String JSON_PROPERTY_START_DATE

See Also:

• Constant Field Values

JSON_PROPERTY_END_DATE

public static final String JSON_PROPERTY_END_DATE

See Also:

• Constant Field Values

JSON_PROPERTY_STATE

public static final String JSON_PROPERTY_STATE

See Also:

• Constant Field Values

JSON_PROPERTY_HAS_INCIDENT

public static final String JSON_PROPERTY_HAS_INCIDENT

See Also:

• Constant Field Values

JSON_PROPERTY_TENANT_ID

public static final String JSON_PROPERTY_TENANT_ID

See Also:

• Constant Field Values

JSON_PROPERTY_VARIABLES

public static final String JSON_PROPERTY_VARIABLES

See Also:

• Constant Field Values

JSON_PROPERTY_PROCESS_INSTANCE_KEY

public static final String JSON_PROPERTY_PROCESS_INSTANCE_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_PARENT_PROCESS_INSTANCE_KEY

public static final String JSON_PROPERTY_PARENT_PROCESS_INSTANCE_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_PARENT_ELEMENT_INSTANCE_KEY

public static final String JSON_PROPERTY_PARENT_ELEMENT_INSTANCE_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_BATCH_OPERATION_ID

public static final String JSON_PROPERTY_BATCH_OPERATION_ID

See Also:

• Constant Field Values

JSON_PROPERTY_ERROR_MESSAGE

public static final String JSON_PROPERTY_ERROR_MESSAGE

See Also:

• Constant Field Values

JSON_PROPERTY_HAS_RETRIES_LEFT

public static final String JSON_PROPERTY_HAS_RETRIES_LEFT

See Also:

• Constant Field Values

JSON_PROPERTY_ELEMENT_INSTANCE_STATE

public static final String JSON_PROPERTY_ELEMENT_INSTANCE_STATE

See Also:

• Constant Field Values

JSON_PROPERTY_ELEMENT_ID

public static final String JSON_PROPERTY_ELEMENT_ID

See Also:

• Constant Field Values

JSON_PROPERTY_HAS_ELEMENT_INSTANCE_INCIDENT

public static final String JSON_PROPERTY_HAS_ELEMENT_INSTANCE_INCIDENT

See Also:

• Constant Field Values

JSON_PROPERTY_INCIDENT_ERROR_HASH_CODE

public static final String JSON_PROPERTY_INCIDENT_ERROR_HASH_CODE

See Also:

• Constant Field Values

JSON_PROPERTY_$_OR

public static final String JSON_PROPERTY_$_OR

See Also:

• Constant Field Values

Constructor Details

ProcessInstanceFilter

public ProcessInstanceFilter()

Method Details

processDefinitionId

public ProcessInstanceFilter processDefinitionId(@Nullable
 StringFilterProperty processDefinitionId)

getProcessDefinitionId

@Nullable
public StringFilterProperty getProcessDefinitionId()

The process definition ID.

Returns:

processDefinitionId

setProcessDefinitionId

public void setProcessDefinitionId(@Nullable
 StringFilterProperty processDefinitionId)

processDefinitionName

public ProcessInstanceFilter processDefinitionName(@Nullable
 StringFilterProperty processDefinitionName)

getProcessDefinitionName

@Nullable
public StringFilterProperty getProcessDefinitionName()

The process definition name.

Returns:

processDefinitionName

setProcessDefinitionName

public void setProcessDefinitionName(@Nullable
 StringFilterProperty processDefinitionName)

processDefinitionVersion

public ProcessInstanceFilter processDefinitionVersion(@Nullable
 IntegerFilterProperty processDefinitionVersion)

getProcessDefinitionVersion

@Nullable
public IntegerFilterProperty getProcessDefinitionVersion()

The process definition version.

Returns:

processDefinitionVersion

setProcessDefinitionVersion

public void setProcessDefinitionVersion(@Nullable
 IntegerFilterProperty processDefinitionVersion)

processDefinitionVersionTag

public ProcessInstanceFilter processDefinitionVersionTag(@Nullable
 StringFilterProperty processDefinitionVersionTag)

getProcessDefinitionVersionTag

@Nullable
public StringFilterProperty getProcessDefinitionVersionTag()

The process definition version tag.

Returns:

processDefinitionVersionTag

setProcessDefinitionVersionTag

public void setProcessDefinitionVersionTag(@Nullable
 StringFilterProperty processDefinitionVersionTag)

processDefinitionKey

public ProcessInstanceFilter processDefinitionKey(@Nullable
 BasicStringFilterProperty processDefinitionKey)

getProcessDefinitionKey

@Nullable
public BasicStringFilterProperty getProcessDefinitionKey()

The process definition key.

Returns:

processDefinitionKey

setProcessDefinitionKey

public void setProcessDefinitionKey(@Nullable
 BasicStringFilterProperty processDefinitionKey)

startDate

public ProcessInstanceFilter startDate(@Nullable
 DateTimeFilterProperty startDate)

getStartDate

@Nullable
public DateTimeFilterProperty getStartDate()

The start date.

Returns:

startDate

setStartDate

public void setStartDate(@Nullable
 DateTimeFilterProperty startDate)

endDate

public ProcessInstanceFilter endDate(@Nullable
 DateTimeFilterProperty endDate)

getEndDate

@Nullable
public DateTimeFilterProperty getEndDate()

The end date.

Returns:

endDate

setEndDate

public void setEndDate(@Nullable
 DateTimeFilterProperty endDate)

state

public ProcessInstanceFilter state(@Nullable
 ProcessInstanceStateFilterProperty state)

getState

@Nullable
public ProcessInstanceStateFilterProperty getState()

The process instance state.

Returns:

state

setState

public void setState(@Nullable
 ProcessInstanceStateFilterProperty state)

hasIncident

public ProcessInstanceFilter hasIncident(@Nullable
 Boolean hasIncident)

getHasIncident

@Nullable
public Boolean getHasIncident()

Whether this process instance has a related incident or not.

Returns:

hasIncident

setHasIncident

public void setHasIncident(@Nullable
 Boolean hasIncident)

tenantId

public ProcessInstanceFilter tenantId(@Nullable
 StringFilterProperty tenantId)

getTenantId

@Nullable
public StringFilterProperty getTenantId()

The tenant ID.

Returns:

tenantId

setTenantId

public void setTenantId(@Nullable
 StringFilterProperty tenantId)

variables

public ProcessInstanceFilter variables(@Nullable
 List<VariableValueFilterRequest> variables)

addVariablesItem

public ProcessInstanceFilter addVariablesItem(VariableValueFilterRequest variablesItem)

getVariables

@Nullable
public List<VariableValueFilterRequest> getVariables()

The process instance variables.

Returns:

variables

setVariables

public void setVariables(@Nullable
 List<VariableValueFilterRequest> variables)

processInstanceKey

public ProcessInstanceFilter processInstanceKey(@Nullable
 BasicStringFilterProperty processInstanceKey)

getProcessInstanceKey

@Nullable
public BasicStringFilterProperty getProcessInstanceKey()

The key of this process instance.

Returns:

processInstanceKey

setProcessInstanceKey

public void setProcessInstanceKey(@Nullable
 BasicStringFilterProperty processInstanceKey)

parentProcessInstanceKey

public ProcessInstanceFilter parentProcessInstanceKey(@Nullable
 BasicStringFilterProperty parentProcessInstanceKey)

getParentProcessInstanceKey

@Nullable
public BasicStringFilterProperty getParentProcessInstanceKey()

The parent process instance key.

Returns:

parentProcessInstanceKey

setParentProcessInstanceKey

public void setParentProcessInstanceKey(@Nullable
 BasicStringFilterProperty parentProcessInstanceKey)

parentElementInstanceKey

public ProcessInstanceFilter parentElementInstanceKey(@Nullable
 BasicStringFilterProperty parentElementInstanceKey)

getParentElementInstanceKey

@Nullable
public BasicStringFilterProperty getParentElementInstanceKey()

The parent element instance key.

Returns:

parentElementInstanceKey

setParentElementInstanceKey

public void setParentElementInstanceKey(@Nullable
 BasicStringFilterProperty parentElementInstanceKey)

batchOperationId

public ProcessInstanceFilter batchOperationId(@Nullable
 StringFilterProperty batchOperationId)

getBatchOperationId

@Nullable
public StringFilterProperty getBatchOperationId()

The batch operation ID.

Returns:

batchOperationId

setBatchOperationId

public void setBatchOperationId(@Nullable
 StringFilterProperty batchOperationId)

errorMessage

public ProcessInstanceFilter errorMessage(@Nullable
 StringFilterProperty errorMessage)

getErrorMessage

@Nullable
public StringFilterProperty getErrorMessage()

The error message related to the process.

Returns:

errorMessage

setErrorMessage

public void setErrorMessage(@Nullable
 StringFilterProperty errorMessage)

hasRetriesLeft

public ProcessInstanceFilter hasRetriesLeft(@Nullable
 Boolean hasRetriesLeft)

getHasRetriesLeft

@Nullable
public Boolean getHasRetriesLeft()

Whether the process has failed jobs with retries left.

Returns:

hasRetriesLeft

setHasRetriesLeft

public void setHasRetriesLeft(@Nullable
 Boolean hasRetriesLeft)

elementInstanceState

public ProcessInstanceFilter elementInstanceState(@Nullable
 ElementInstanceStateFilterProperty elementInstanceState)

getElementInstanceState

@Nullable
public ElementInstanceStateFilterProperty getElementInstanceState()

The state of the element instances associated with the process instance.

Returns:

elementInstanceState

setElementInstanceState

public void setElementInstanceState(@Nullable
 ElementInstanceStateFilterProperty elementInstanceState)

elementId

public ProcessInstanceFilter elementId(@Nullable
 StringFilterProperty elementId)

getElementId

@Nullable
public StringFilterProperty getElementId()

The element ID associated with the process instance.

Returns:

elementId

setElementId

public void setElementId(@Nullable
 StringFilterProperty elementId)

hasElementInstanceIncident

public ProcessInstanceFilter hasElementInstanceIncident(@Nullable
 Boolean hasElementInstanceIncident)

getHasElementInstanceIncident

@Nullable
public Boolean getHasElementInstanceIncident()

Whether the element instance has an incident or not.

Returns:

hasElementInstanceIncident

setHasElementInstanceIncident

public void setHasElementInstanceIncident(@Nullable
 Boolean hasElementInstanceIncident)

incidentErrorHashCode

public ProcessInstanceFilter incidentErrorHashCode(@Nullable
 Integer incidentErrorHashCode)

getIncidentErrorHashCode

@Nullable
public Integer getIncidentErrorHashCode()

The incident error hash code, associated with this process.

Returns:

incidentErrorHashCode

setIncidentErrorHashCode

public void setIncidentErrorHashCode(@Nullable
 Integer incidentErrorHashCode)

$or

public ProcessInstanceFilter $or(@Nullable
 List<ProcessInstanceFilterFields> $or)

add$OrItem

public ProcessInstanceFilter add$OrItem(ProcessInstanceFilterFields $orItem)

get$Or

@Nullable
public List<ProcessInstanceFilterFields> get$Or()

Defines a list of alternative filter groups combined using OR logic. Each object in the array is evaluated independently, and the filter matches if any one of them is satisfied. Top-level fields and the `$or` clause are combined using AND logic — meaning: (top-level filters) AND (any of the `$or` filters) must match. <br> <em>Example:</em> ```json { \"state\": \"ACTIVE\", \"tenantId\": 123, \"$or\": [ { \"processDefinitionId\": \"process_v1\" }, { \"processDefinitionId\": \"process_v2\", \"hasIncident\": true } ] } ``` This matches process instances that: <ul style=\"padding-left: 20px; margin-left: 20px;\"> <li style=\"list-style-type: disc;\">are in <em>ACTIVE</em> state</li> <li style=\"list-style-type: disc;\">have tenant ID equal to <em>123</em></li> <li style=\"list-style-type: disc;\">and match either: <ul style=\"padding-left: 20px; margin-left: 20px;\"> <li style=\"list-style-type: circle;\"><code>processDefinitionId</code> is <em>process_v1</em>, or</li> <li style=\"list-style-type: circle;\"><code>processDefinitionId</code> is <em>process_v2</em> and <code>hasIncident</code> is <em>true</em></li> </ul> </li> </ul> <br> <p>Note: Using complex <code>$or</code> conditions may impact performance, use with caution in high-volume environments.

Returns:

$or

set$Or

public void set$Or(@Nullable
 List<ProcessInstanceFilterFields> $or)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toUrlQueryString

public String toUrlQueryString()

Convert the instance into URL query string.

Returns:

URL query string

toUrlQueryString

public String toUrlQueryString(String prefix)

Convert the instance into URL query string.

Parameters:

prefix - prefix of the query string

Returns:

URL query string