Package io.camunda.client.protocol.rest

Class ElementInstanceFilter

java.lang.Object

io.camunda.client.protocol.rest.ElementInstanceFilter

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2025-10-08T19:37:20.302687113Z[GMT]",
           comments="Generator version: 7.12.0")
public class ElementInstanceFilter
extends Object

Element instance filter.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ElementInstanceFilter.TypeEnum	Type of element as defined set of values.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_ELEMENT_ID
static final String	JSON_PROPERTY_ELEMENT_INSTANCE_KEY
static final String	JSON_PROPERTY_ELEMENT_INSTANCE_SCOPE_KEY
static final String	JSON_PROPERTY_ELEMENT_NAME
static final String	JSON_PROPERTY_END_DATE
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_START_DATE
static final String	JSON_PROPERTY_STATE
static final String	JSON_PROPERTY_TENANT_ID
static final String	JSON_PROPERTY_TYPE

Constructor Summary

Constructors

Constructor	Description
ElementInstanceFilter()

Method Summary

Modifier and Type	Method	Description
ElementInstanceFilter	elementId(String elementId)
ElementInstanceFilter	elementInstanceKey(String elementInstanceKey)
ElementInstanceFilter	elementInstanceScopeKey(String elementInstanceScopeKey)
ElementInstanceFilter	elementName(String elementName)
ElementInstanceFilter	endDate(DateTimeFilterProperty endDate)
boolean	equals(Object o)
String	getElementId()	The element ID for this element instance.
String	getElementInstanceKey()	The assigned key, which acts as a unique identifier for this element instance.
String	getElementInstanceScopeKey()	The scope key of this element instance.
String	getElementName()	The element name.
DateTimeFilterProperty	getEndDate()	The end date of this element instance.
Boolean	getHasIncident()	Shows whether this element 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 element instance.
String	getProcessDefinitionKey()	The process definition key associated to this element instance.
String	getProcessInstanceKey()	The process instance key associated to this element instance.
DateTimeFilterProperty	getStartDate()	The start date of this element instance.
ElementInstanceStateFilterProperty	getState()	State of element instance as defined set of values.
String	getTenantId()	The tenant ID.
ElementInstanceFilter.TypeEnum	getType()	Type of element as defined set of values.
int	hashCode()
ElementInstanceFilter	hasIncident(Boolean hasIncident)
ElementInstanceFilter	incidentKey(String incidentKey)
ElementInstanceFilter	processDefinitionId(String processDefinitionId)
ElementInstanceFilter	processDefinitionKey(String processDefinitionKey)
ElementInstanceFilter	processInstanceKey(String processInstanceKey)
void	setElementId(String elementId)
void	setElementInstanceKey(String elementInstanceKey)
void	setElementInstanceScopeKey(String elementInstanceScopeKey)
void	setElementName(String elementName)
void	setEndDate(DateTimeFilterProperty endDate)
void	setHasIncident(Boolean hasIncident)
void	setIncidentKey(String incidentKey)
void	setProcessDefinitionId(String processDefinitionId)
void	setProcessDefinitionKey(String processDefinitionKey)
void	setProcessInstanceKey(String processInstanceKey)
void	setStartDate(DateTimeFilterProperty startDate)
void	setState(ElementInstanceStateFilterProperty state)
void	setTenantId(String tenantId)
void	setType(ElementInstanceFilter.TypeEnum type)
ElementInstanceFilter	startDate(DateTimeFilterProperty startDate)
ElementInstanceFilter	state(ElementInstanceStateFilterProperty state)
ElementInstanceFilter	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.
ElementInstanceFilter	type(ElementInstanceFilter.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_ELEMENT_ID

public static final String JSON_PROPERTY_ELEMENT_ID

See Also:

• Constant Field Values

JSON_PROPERTY_ELEMENT_NAME

public static final String JSON_PROPERTY_ELEMENT_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_ELEMENT_INSTANCE_KEY

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

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_ELEMENT_INSTANCE_SCOPE_KEY

public static final String JSON_PROPERTY_ELEMENT_INSTANCE_SCOPE_KEY

See Also:

• Constant Field Values

Constructor Details

ElementInstanceFilter

public ElementInstanceFilter()

Method Details

processDefinitionId

public ElementInstanceFilter processDefinitionId(@Nullable
 String processDefinitionId)

getProcessDefinitionId

@Nullable
public String getProcessDefinitionId()

The process definition ID associated to this element instance.

Returns:

processDefinitionId

setProcessDefinitionId

public void setProcessDefinitionId(@Nullable
 String processDefinitionId)

state

public ElementInstanceFilter state(@Nullable
 ElementInstanceStateFilterProperty state)

getState

@Nullable
public ElementInstanceStateFilterProperty getState()

State of element instance as defined set of values.

Returns:

state

setState

public void setState(@Nullable
 ElementInstanceStateFilterProperty state)

type

public ElementInstanceFilter type(@Nullable
 ElementInstanceFilter.TypeEnum type)

getType

@Nullable
public ElementInstanceFilter.TypeEnum getType()

Type of element as defined set of values.

Returns:

type

setType

public void setType(@Nullable
 ElementInstanceFilter.TypeEnum type)

elementId

public ElementInstanceFilter elementId(@Nullable
 String elementId)

getElementId

@Nullable
public String getElementId()

The element ID for this element instance.

Returns:

elementId

setElementId

public void setElementId(@Nullable
 String elementId)

elementName

public ElementInstanceFilter elementName(@Nullable
 String elementName)

getElementName

@Nullable
public String getElementName()

The element name. This only works for data created with 8.8 and onwards. Instances from prior versions don't contain this data and cannot be found.

Returns:

elementName

setElementName

public void setElementName(@Nullable
 String elementName)

hasIncident

public ElementInstanceFilter hasIncident(@Nullable
 Boolean hasIncident)

getHasIncident

@Nullable
public Boolean getHasIncident()

Shows whether this element instance has an incident related to.

Returns:

hasIncident

setHasIncident

public void setHasIncident(@Nullable
 Boolean hasIncident)

tenantId

public ElementInstanceFilter tenantId(@Nullable
 String tenantId)

getTenantId

@Nullable
public String getTenantId()

The tenant ID.

Returns:

tenantId

setTenantId

public void setTenantId(@Nullable
 String tenantId)

elementInstanceKey

public ElementInstanceFilter elementInstanceKey(@Nullable
 String elementInstanceKey)

getElementInstanceKey

@Nullable
public String getElementInstanceKey()

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

Returns:

elementInstanceKey

setElementInstanceKey

public void setElementInstanceKey(@Nullable
 String elementInstanceKey)

processInstanceKey

public ElementInstanceFilter processInstanceKey(@Nullable
 String processInstanceKey)

getProcessInstanceKey

@Nullable
public String getProcessInstanceKey()

The process instance key associated to this element instance.

Returns:

processInstanceKey

setProcessInstanceKey

public void setProcessInstanceKey(@Nullable
 String processInstanceKey)

processDefinitionKey

public ElementInstanceFilter processDefinitionKey(@Nullable
 String processDefinitionKey)

getProcessDefinitionKey

@Nullable
public String getProcessDefinitionKey()

The process definition key associated to this element instance.

Returns:

processDefinitionKey

setProcessDefinitionKey

public void setProcessDefinitionKey(@Nullable
 String processDefinitionKey)

incidentKey

public ElementInstanceFilter 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)

startDate

public ElementInstanceFilter startDate(@Nullable
 DateTimeFilterProperty startDate)

getStartDate

@Nullable
public DateTimeFilterProperty getStartDate()

The start date of this element instance.

Returns:

startDate

setStartDate

public void setStartDate(@Nullable
 DateTimeFilterProperty startDate)

endDate

public ElementInstanceFilter endDate(@Nullable
 DateTimeFilterProperty endDate)

getEndDate

@Nullable
public DateTimeFilterProperty getEndDate()

The end date of this element instance.

Returns:

endDate

setEndDate

public void setEndDate(@Nullable
 DateTimeFilterProperty endDate)

elementInstanceScopeKey

public ElementInstanceFilter elementInstanceScopeKey(@Nullable
 String elementInstanceScopeKey)

getElementInstanceScopeKey

@Nullable
public String getElementInstanceScopeKey()

The scope key of this element instance. If provided with a process instance key it will return element instances that are immediate children of the process instance. If provided with an element instance key it will return element instances that are immediate children of the element instance.

Returns:

elementInstanceScopeKey

setElementInstanceScopeKey

public void setElementInstanceScopeKey(@Nullable
 String elementInstanceScopeKey)

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