Package io.camunda.client.protocol.rest

Class FlowNodeInstanceFilter

java.lang.Object

io.camunda.client.protocol.rest.FlowNodeInstanceFilter

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2025-02-25T13:39:08.081076719Z[GMT]",
           comments="Generator version: 7.10.0")
public class FlowNodeInstanceFilter
extends Object

Flow node instance filter.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FlowNodeInstanceFilter.StateEnum	State of flow node instance as defined set of values.
static enum	FlowNodeInstanceFilter.TypeEnum	Type of flow node as defined set of values.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_FLOW_NODE_ID
static final String	JSON_PROPERTY_FLOW_NODE_INSTANCE_KEY
static final String	JSON_PROPERTY_FLOW_NODE_NAME
static final String	JSON_PROPERTY_HAS_INCIDENT
static final String	JSON_PROPERTY_INCIDENT_KEY
static final String	JSON_PROPERTY_PROCESS_DEFINITION_ID
static final String	JSON_PROPERTY_PROCESS_DEFINITION_KEY
static final String	JSON_PROPERTY_PROCESS_INSTANCE_KEY
static final String	JSON_PROPERTY_STATE
static final String	JSON_PROPERTY_TENANT_ID
static final String	JSON_PROPERTY_TYPE

Constructor Summary

Constructors

Constructor	Description
FlowNodeInstanceFilter()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
FlowNodeInstanceFilter	flowNodeId(String flowNodeId)
FlowNodeInstanceFilter	flowNodeInstanceKey(String flowNodeInstanceKey)
FlowNodeInstanceFilter	flowNodeName(String flowNodeName)
String	getFlowNodeId()	The flow node ID for this flow node instance.
String	getFlowNodeInstanceKey()	The assigned key, which acts as a unique identifier for this flow node instance.
String	getFlowNodeName()	The flow node name.
Boolean	getHasIncident()	Shows whether this flow node instance has an incident related to.
String	getIncidentKey()	The key of incident if field incident is true.
String	getProcessDefinitionId()	The process definition ID associated to this flow node instance.
String	getProcessDefinitionKey()	The process definition key associated to this flow node instance.
String	getProcessInstanceKey()	The process instance key associated to this flow node instance.
FlowNodeInstanceFilter.StateEnum	getState()	State of flow node instance as defined set of values.
String	getTenantId()	The tenant ID.
FlowNodeInstanceFilter.TypeEnum	getType()	Type of flow node as defined set of values.
int	hashCode()
FlowNodeInstanceFilter	hasIncident(Boolean hasIncident)
FlowNodeInstanceFilter	incidentKey(String incidentKey)
FlowNodeInstanceFilter	processDefinitionId(String processDefinitionId)
FlowNodeInstanceFilter	processDefinitionKey(String processDefinitionKey)
FlowNodeInstanceFilter	processInstanceKey(String processInstanceKey)
void	setFlowNodeId(String flowNodeId)
void	setFlowNodeInstanceKey(String flowNodeInstanceKey)
void	setFlowNodeName(String flowNodeName)
void	setHasIncident(Boolean hasIncident)
void	setIncidentKey(String incidentKey)
void	setProcessDefinitionId(String processDefinitionId)
void	setProcessDefinitionKey(String processDefinitionKey)
void	setProcessInstanceKey(String processInstanceKey)
void	setState(FlowNodeInstanceFilter.StateEnum state)
void	setTenantId(String tenantId)
void	setType(FlowNodeInstanceFilter.TypeEnum type)
FlowNodeInstanceFilter	state(FlowNodeInstanceFilter.StateEnum state)
FlowNodeInstanceFilter	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.
FlowNodeInstanceFilter	type(FlowNodeInstanceFilter.TypeEnum type)

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_STATE

public static final String JSON_PROPERTY_STATE

See Also:

• Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_FLOW_NODE_ID

public static final String JSON_PROPERTY_FLOW_NODE_ID

See Also:

• Constant Field Values

JSON_PROPERTY_FLOW_NODE_NAME

public static final String JSON_PROPERTY_FLOW_NODE_NAME

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_FLOW_NODE_INSTANCE_KEY

public static final String JSON_PROPERTY_FLOW_NODE_INSTANCE_KEY

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_INCIDENT_KEY

public static final String JSON_PROPERTY_INCIDENT_KEY

See Also:

• Constant Field Values

Constructor Details

FlowNodeInstanceFilter

public FlowNodeInstanceFilter()

Method Details

processDefinitionId

public FlowNodeInstanceFilter processDefinitionId(@Nullable
 String processDefinitionId)

getProcessDefinitionId

@Nullable
public String getProcessDefinitionId()

The process definition ID associated to this flow node instance.

Returns:

processDefinitionId

setProcessDefinitionId

public void setProcessDefinitionId(@Nullable
 String processDefinitionId)

state

public FlowNodeInstanceFilter state(@Nullable
 FlowNodeInstanceFilter.StateEnum state)

getState

@Nullable
public FlowNodeInstanceFilter.StateEnum getState()

State of flow node instance as defined set of values.

Returns:

state

setState

public void setState(@Nullable
 FlowNodeInstanceFilter.StateEnum state)

type

public FlowNodeInstanceFilter type(@Nullable
 FlowNodeInstanceFilter.TypeEnum type)

getType

@Nullable
public FlowNodeInstanceFilter.TypeEnum getType()

Type of flow node as defined set of values.

Returns:

type

setType

public void setType(@Nullable
 FlowNodeInstanceFilter.TypeEnum type)

flowNodeId

public FlowNodeInstanceFilter flowNodeId(@Nullable
 String flowNodeId)

getFlowNodeId

@Nullable
public String getFlowNodeId()

The flow node ID for this flow node instance.

Returns:

flowNodeId

setFlowNodeId

public void setFlowNodeId(@Nullable
 String flowNodeId)

flowNodeName

public FlowNodeInstanceFilter flowNodeName(@Nullable
 String flowNodeName)

getFlowNodeName

@Nullable
public String getFlowNodeName()

The flow node name.

Returns:

flowNodeName

setFlowNodeName

public void setFlowNodeName(@Nullable
 String flowNodeName)

hasIncident

public FlowNodeInstanceFilter hasIncident(@Nullable
 Boolean hasIncident)

getHasIncident

@Nullable
public Boolean getHasIncident()

Shows whether this flow node instance has an incident related to.

Returns:

hasIncident

setHasIncident

public void setHasIncident(@Nullable
 Boolean hasIncident)

tenantId

public FlowNodeInstanceFilter tenantId(@Nullable
 String tenantId)

getTenantId

@Nullable
public String getTenantId()

The tenant ID.

Returns:

tenantId

setTenantId

public void setTenantId(@Nullable
 String tenantId)

flowNodeInstanceKey

public FlowNodeInstanceFilter flowNodeInstanceKey(@Nullable
 String flowNodeInstanceKey)

getFlowNodeInstanceKey

@Nullable
public String getFlowNodeInstanceKey()

The assigned key, which acts as a unique identifier for this flow node instance.

Returns:

flowNodeInstanceKey

setFlowNodeInstanceKey

public void setFlowNodeInstanceKey(@Nullable
 String flowNodeInstanceKey)

processInstanceKey

public FlowNodeInstanceFilter processInstanceKey(@Nullable
 String processInstanceKey)

getProcessInstanceKey

@Nullable
public String getProcessInstanceKey()

The process instance key associated to this flow node instance.

Returns:

processInstanceKey

setProcessInstanceKey

public void setProcessInstanceKey(@Nullable
 String processInstanceKey)

processDefinitionKey

public FlowNodeInstanceFilter processDefinitionKey(@Nullable
 String processDefinitionKey)

getProcessDefinitionKey

@Nullable
public String getProcessDefinitionKey()

The process definition key associated to this flow node instance.

Returns:

processDefinitionKey

setProcessDefinitionKey

public void setProcessDefinitionKey(@Nullable
 String processDefinitionKey)

incidentKey

public FlowNodeInstanceFilter incidentKey(@Nullable
 String incidentKey)

getIncidentKey

@Nullable
public String getIncidentKey()

The key of incident if field incident is true.

Returns:

incidentKey

setIncidentKey

public void setIncidentKey(@Nullable
 String incidentKey)

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