Package io.camunda.client.protocol.rest

Class ElementInstanceResult

java.lang.Object

io.camunda.client.protocol.rest.ElementInstanceResult

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

ElementInstanceResult

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ElementInstanceResult.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_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
ElementInstanceResult()

Method Summary

Modifier and Type	Method	Description
ElementInstanceResult	elementId(String elementId)
ElementInstanceResult	elementInstanceKey(String elementInstanceKey)
ElementInstanceResult	elementName(String elementName)
ElementInstanceResult	endDate(String 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	getElementName()	The element name for this element instance.
String	getEndDate()	Date when element instance finished.
Boolean	getHasIncident()	Shows whether this element instance has an incident.
String	getIncidentKey()	Incident key associated with this element instance.
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.
String	getStartDate()	Date when element instance started.
ElementInstanceStateEnum	getState()	State of element instance as defined set of values.
String	getTenantId()	The tenant ID of the incident.
ElementInstanceResult.TypeEnum	getType()	Type of element as defined set of values.
int	hashCode()
ElementInstanceResult	hasIncident(Boolean hasIncident)
ElementInstanceResult	incidentKey(String incidentKey)
ElementInstanceResult	processDefinitionId(String processDefinitionId)
ElementInstanceResult	processDefinitionKey(String processDefinitionKey)
ElementInstanceResult	processInstanceKey(String processInstanceKey)
void	setElementId(String elementId)
void	setElementInstanceKey(String elementInstanceKey)
void	setElementName(String elementName)
void	setEndDate(String endDate)
void	setHasIncident(Boolean hasIncident)
void	setIncidentKey(String incidentKey)
void	setProcessDefinitionId(String processDefinitionId)
void	setProcessDefinitionKey(String processDefinitionKey)
void	setProcessInstanceKey(String processInstanceKey)
void	setStartDate(String startDate)
void	setState(ElementInstanceStateEnum state)
void	setTenantId(String tenantId)
void	setType(ElementInstanceResult.TypeEnum type)
ElementInstanceResult	startDate(String startDate)
ElementInstanceResult	state(ElementInstanceStateEnum state)
ElementInstanceResult	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.
ElementInstanceResult	type(ElementInstanceResult.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_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_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_TYPE

public static final String JSON_PROPERTY_TYPE

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_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

Constructor Details

ElementInstanceResult

public ElementInstanceResult()

Method Details

processDefinitionId

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

startDate

public ElementInstanceResult startDate(@Nullable
 String startDate)

getStartDate

@Nullable
public String getStartDate()

Date when element instance started.

Returns:

startDate

setStartDate

public void setStartDate(@Nullable
 String startDate)

endDate

public ElementInstanceResult endDate(@Nullable
 String endDate)

getEndDate

@Nullable
public String getEndDate()

Date when element instance finished.

Returns:

endDate

setEndDate

public void setEndDate(@Nullable
 String endDate)

elementId

public ElementInstanceResult 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 ElementInstanceResult elementName(@Nullable
 String elementName)

getElementName

@Nullable
public String getElementName()

The element name for this element instance.

Returns:

elementName

setElementName

public void setElementName(@Nullable
 String elementName)

type

public ElementInstanceResult type(@Nullable
 ElementInstanceResult.TypeEnum type)

getType

@Nullable
public ElementInstanceResult.TypeEnum getType()

Type of element as defined set of values.

Returns:

type

setType

public void setType(@Nullable
 ElementInstanceResult.TypeEnum type)

state

public ElementInstanceResult state(@Nullable
 ElementInstanceStateEnum state)

getState

@Nullable
public ElementInstanceStateEnum getState()

State of element instance as defined set of values.

Returns:

state

setState

public void setState(@Nullable
 ElementInstanceStateEnum state)

hasIncident

public ElementInstanceResult hasIncident(@Nullable
 Boolean hasIncident)

getHasIncident

@Nullable
public Boolean getHasIncident()

Shows whether this element instance has an incident. If true also an incidentKey is provided.

Returns:

hasIncident

setHasIncident

public void setHasIncident(@Nullable
 Boolean hasIncident)

tenantId

public ElementInstanceResult tenantId(@Nullable
 String tenantId)

getTenantId

@Nullable
public String getTenantId()

The tenant ID of the incident.

Returns:

tenantId

setTenantId

public void setTenantId(@Nullable
 String tenantId)

elementInstanceKey

public ElementInstanceResult 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 ElementInstanceResult 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 ElementInstanceResult 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 ElementInstanceResult incidentKey(@Nullable
 String incidentKey)

getIncidentKey

@Nullable
public String getIncidentKey()

Incident key associated with this element instance.

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