Package io.camunda.zeebe.client.protocol.rest

Class ProcessInstanceFilter

java.lang.Object

io.camunda.zeebe.client.protocol.rest.ProcessInstanceFilter

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

ProcessInstanceFilter

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_ACTIVE
static final String	JSON_PROPERTY_ACTIVITY_ID
static final String	JSON_PROPERTY_BATCH_OPERATION_ID
static final String	JSON_PROPERTY_BPMN_PROCESS_ID
static final String	JSON_PROPERTY_CANCELED
static final String	JSON_PROPERTY_COMPLETED
static final String	JSON_PROPERTY_END_DATE
static final String	JSON_PROPERTY_ERROR_MESSAGE
static final String	JSON_PROPERTY_FINISHED
static final String	JSON_PROPERTY_INCIDENTS
static final String	JSON_PROPERTY_PARENT_PROCESS_INSTANCE_KEY
static final String	JSON_PROPERTY_PROCESS_DEFINITION_VERSION
static final String	JSON_PROPERTY_RETRIES_LEFT
static final String	JSON_PROPERTY_RUNNING
static final String	JSON_PROPERTY_START_DATE
static final String	JSON_PROPERTY_TENANT_ID
static final String	JSON_PROPERTY_VARIABLE

Constructor Summary

Constructors

Constructor	Description
ProcessInstanceFilter()

Method Summary

Modifier and Type	Method	Description
ProcessInstanceFilter	active(Boolean active)
ProcessInstanceFilter	activityId(String activityId)
ProcessInstanceFilter	batchOperationId(String batchOperationId)
ProcessInstanceFilter	bpmnProcessId(String bpmnProcessId)
ProcessInstanceFilter	canceled(Boolean canceled)
ProcessInstanceFilter	completed(Boolean completed)
ProcessInstanceFilter	endDate(String endDate)
boolean	equals(Object o)
ProcessInstanceFilter	errorMessage(String errorMessage)
ProcessInstanceFilter	finished(Boolean finished)
Boolean	getActive()	Get active
String	getActivityId()	Get activityId
String	getBatchOperationId()	Get batchOperationId
String	getBpmnProcessId()	The bpmn process ID.
Boolean	getCanceled()	Get canceled
Boolean	getCompleted()	Get completed
String	getEndDate()	Get endDate
String	getErrorMessage()	Get errorMessage
Boolean	getFinished()	Get finished
Boolean	getIncidents()	Get incidents
String	getParentProcessInstanceKey()	Get parentProcessInstanceKey
Integer	getProcessDefinitionVersion()	Get processDefinitionVersion
Boolean	getRetriesLeft()	Get retriesLeft
Boolean	getRunning()	Get running
String	getStartDate()	Get startDate
String	getTenantId()	Get tenantId
ProcessInstanceVariableFilterRequest	getVariable()	Get variable
int	hashCode()
ProcessInstanceFilter	incidents(Boolean incidents)
ProcessInstanceFilter	parentProcessInstanceKey(String parentProcessInstanceKey)
ProcessInstanceFilter	processDefinitionVersion(Integer processDefinitionVersion)
ProcessInstanceFilter	retriesLeft(Boolean retriesLeft)
ProcessInstanceFilter	running(Boolean running)
void	setActive(Boolean active)
void	setActivityId(String activityId)
void	setBatchOperationId(String batchOperationId)
void	setBpmnProcessId(String bpmnProcessId)
void	setCanceled(Boolean canceled)
void	setCompleted(Boolean completed)
void	setEndDate(String endDate)
void	setErrorMessage(String errorMessage)
void	setFinished(Boolean finished)
void	setIncidents(Boolean incidents)
void	setParentProcessInstanceKey(String parentProcessInstanceKey)
void	setProcessDefinitionVersion(Integer processDefinitionVersion)
void	setRetriesLeft(Boolean retriesLeft)
void	setRunning(Boolean running)
void	setStartDate(String startDate)
void	setTenantId(String tenantId)
void	setVariable(ProcessInstanceVariableFilterRequest variable)
ProcessInstanceFilter	startDate(String startDate)
ProcessInstanceFilter	tenantId(String tenantId)
String	toString()
String	toUrlQueryString()	Convert the instance into URL query string.
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.
ProcessInstanceFilter	variable(ProcessInstanceVariableFilterRequest variable)

Methods inherited from class java.lang.Object

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

Field Details

JSON_PROPERTY_PARENT_PROCESS_INSTANCE_KEY

public static final String JSON_PROPERTY_PARENT_PROCESS_INSTANCE_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_RUNNING

public static final String JSON_PROPERTY_RUNNING

See Also:

• Constant Field Values

JSON_PROPERTY_ACTIVE

public static final String JSON_PROPERTY_ACTIVE

See Also:

• Constant Field Values

JSON_PROPERTY_INCIDENTS

public static final String JSON_PROPERTY_INCIDENTS

See Also:

• Constant Field Values

JSON_PROPERTY_FINISHED

public static final String JSON_PROPERTY_FINISHED

See Also:

• Constant Field Values

JSON_PROPERTY_COMPLETED

public static final String JSON_PROPERTY_COMPLETED

See Also:

• Constant Field Values

JSON_PROPERTY_CANCELED

public static final String JSON_PROPERTY_CANCELED

See Also:

• Constant Field Values

JSON_PROPERTY_RETRIES_LEFT

public static final String JSON_PROPERTY_RETRIES_LEFT

See Also:

• Constant Field Values

JSON_PROPERTY_ERROR_MESSAGE

public static final String JSON_PROPERTY_ERROR_MESSAGE

See Also:

• Constant Field Values

JSON_PROPERTY_ACTIVITY_ID

public static final String JSON_PROPERTY_ACTIVITY_ID

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_BPMN_PROCESS_ID

public static final String JSON_PROPERTY_BPMN_PROCESS_ID

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_VARIABLE

public static final String JSON_PROPERTY_VARIABLE

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_TENANT_ID

public static final String JSON_PROPERTY_TENANT_ID

See Also:

• Constant Field Values

Constructor Details

ProcessInstanceFilter

public ProcessInstanceFilter()

Method Details

parentProcessInstanceKey

public ProcessInstanceFilter parentProcessInstanceKey(String parentProcessInstanceKey)

getParentProcessInstanceKey

@Nullable
public String getParentProcessInstanceKey()

Get parentProcessInstanceKey

Returns:

parentProcessInstanceKey

setParentProcessInstanceKey

public void setParentProcessInstanceKey(String parentProcessInstanceKey)

running

public ProcessInstanceFilter running(Boolean running)

getRunning

@Nullable
public Boolean getRunning()

Get running

Returns:

running

setRunning

public void setRunning(Boolean running)

active

public ProcessInstanceFilter active(Boolean active)

getActive

@Nullable
public Boolean getActive()

Get active

Returns:

active

setActive

public void setActive(Boolean active)

incidents

public ProcessInstanceFilter incidents(Boolean incidents)

getIncidents

@Nullable
public Boolean getIncidents()

Get incidents

Returns:

incidents

setIncidents

public void setIncidents(Boolean incidents)

finished

public ProcessInstanceFilter finished(Boolean finished)

getFinished

@Nullable
public Boolean getFinished()

Get finished

Returns:

finished

setFinished

public void setFinished(Boolean finished)

completed

public ProcessInstanceFilter completed(Boolean completed)

getCompleted

@Nullable
public Boolean getCompleted()

Get completed

Returns:

completed

setCompleted

public void setCompleted(Boolean completed)

canceled

public ProcessInstanceFilter canceled(Boolean canceled)

getCanceled

@Nullable
public Boolean getCanceled()

Get canceled

Returns:

canceled

setCanceled

public void setCanceled(Boolean canceled)

retriesLeft

public ProcessInstanceFilter retriesLeft(Boolean retriesLeft)

getRetriesLeft

@Nullable
public Boolean getRetriesLeft()

Get retriesLeft

Returns:

retriesLeft

setRetriesLeft

public void setRetriesLeft(Boolean retriesLeft)

errorMessage

public ProcessInstanceFilter errorMessage(String errorMessage)

getErrorMessage

@Nullable
public String getErrorMessage()

Get errorMessage

Returns:

errorMessage

setErrorMessage

public void setErrorMessage(String errorMessage)

activityId

public ProcessInstanceFilter activityId(String activityId)

getActivityId

@Nullable
public String getActivityId()

Get activityId

Returns:

activityId

setActivityId

public void setActivityId(String activityId)

startDate

public ProcessInstanceFilter startDate(String startDate)

getStartDate

@Nullable
public String getStartDate()

Get startDate

Returns:

startDate

setStartDate

public void setStartDate(String startDate)

endDate

public ProcessInstanceFilter endDate(String endDate)

getEndDate

@Nullable
public String getEndDate()

Get endDate

Returns:

endDate

setEndDate

public void setEndDate(String endDate)

bpmnProcessId

public ProcessInstanceFilter bpmnProcessId(String bpmnProcessId)

getBpmnProcessId

@Nullable
public String getBpmnProcessId()

The bpmn process ID.

Returns:

bpmnProcessId

setBpmnProcessId

public void setBpmnProcessId(String bpmnProcessId)

processDefinitionVersion

public ProcessInstanceFilter processDefinitionVersion(Integer processDefinitionVersion)

getProcessDefinitionVersion

@Nullable
public Integer getProcessDefinitionVersion()

Get processDefinitionVersion

Returns:

processDefinitionVersion

setProcessDefinitionVersion

public void setProcessDefinitionVersion(Integer processDefinitionVersion)

variable

public ProcessInstanceFilter variable(ProcessInstanceVariableFilterRequest variable)

getVariable

@Nullable
public ProcessInstanceVariableFilterRequest getVariable()

Get variable

Returns:

variable

setVariable

public void setVariable(ProcessInstanceVariableFilterRequest variable)

batchOperationId

public ProcessInstanceFilter batchOperationId(String batchOperationId)

getBatchOperationId

@Nullable
public String getBatchOperationId()

Get batchOperationId

Returns:

batchOperationId

setBatchOperationId

public void setBatchOperationId(String batchOperationId)

tenantId

public ProcessInstanceFilter tenantId(String tenantId)

getTenantId

@Nullable
public String getTenantId()

Get tenantId

Returns:

tenantId

setTenantId

public void setTenantId(String tenantId)

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