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-02-25T13:39:08.081076719Z[GMT]",
           comments="Generator version: 7.10.0")
public class ProcessInstanceFilter
extends Object

Process instance search filter.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_END_DATE
static final String	JSON_PROPERTY_HAS_INCIDENT
static final String	JSON_PROPERTY_PARENT_FLOW_NODE_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	addVariablesItem(ProcessInstanceVariableFilterRequest variablesItem)
ProcessInstanceFilter	endDate(DateTimeFilterProperty endDate)
boolean	equals(Object o)
DateTimeFilterProperty	getEndDate()	The end date.
Boolean	getHasIncident()	Whether this process instance has a related incident or not.
BasicStringFilterProperty	getParentFlowNodeInstanceKey()	The parent flow node 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<ProcessInstanceVariableFilterRequest>	getVariables()	The process instance variables.
int	hashCode()
ProcessInstanceFilter	hasIncident(Boolean hasIncident)
ProcessInstanceFilter	parentFlowNodeInstanceKey(BasicStringFilterProperty parentFlowNodeInstanceKey)
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	setEndDate(DateTimeFilterProperty endDate)
void	setHasIncident(Boolean hasIncident)
void	setParentFlowNodeInstanceKey(BasicStringFilterProperty parentFlowNodeInstanceKey)
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<ProcessInstanceVariableFilterRequest> 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<ProcessInstanceVariableFilterRequest> 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_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_PROCESS_DEFINITION_KEY

public static final String JSON_PROPERTY_PROCESS_DEFINITION_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_FLOW_NODE_INSTANCE_KEY

public static final String JSON_PROPERTY_PARENT_FLOW_NODE_INSTANCE_KEY

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)

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<ProcessInstanceVariableFilterRequest> variables)

addVariablesItem

public ProcessInstanceFilter addVariablesItem(ProcessInstanceVariableFilterRequest variablesItem)

getVariables

@Nullable
public List<ProcessInstanceVariableFilterRequest> getVariables()

The process instance variables.

Returns:

variables

setVariables

public void setVariables(@Nullable
 List<ProcessInstanceVariableFilterRequest> 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)

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)

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)

parentFlowNodeInstanceKey

public ProcessInstanceFilter parentFlowNodeInstanceKey(@Nullable
 BasicStringFilterProperty parentFlowNodeInstanceKey)

getParentFlowNodeInstanceKey

@Nullable
public BasicStringFilterProperty getParentFlowNodeInstanceKey()

The parent flow node instance key.

Returns:

parentFlowNodeInstanceKey

setParentFlowNodeInstanceKey

public void setParentFlowNodeInstanceKey(@Nullable
 BasicStringFilterProperty parentFlowNodeInstanceKey)

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