Package io.camunda.client.protocol.rest

Class ProcessInstanceResult

java.lang.Object

io.camunda.client.protocol.rest.ProcessInstanceResult

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

Process instance search response item.

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_ELEMENT_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_TAGS
static final String	JSON_PROPERTY_TENANT_ID

Constructor Summary

Constructors

Constructor	Description
ProcessInstanceResult()

Method Summary

Modifier and Type	Method	Description
ProcessInstanceResult	addTagsItem(String tagsItem)
ProcessInstanceResult	endDate(String endDate)
boolean	equals(Object o)
String	getEndDate()	The end date.
Boolean	getHasIncident()	Whether this process instance has a related incident or not.
String	getParentElementInstanceKey()	The parent element instance key.
String	getParentProcessInstanceKey()	The parent process instance key.
String	getProcessDefinitionId()	The process definition ID.
String	getProcessDefinitionKey()	The process definition key.
String	getProcessDefinitionName()	The process definition name.
Integer	getProcessDefinitionVersion()	The process definition version.
String	getProcessDefinitionVersionTag()	The process definition version tag.
String	getProcessInstanceKey()	The key of this process instance.
String	getStartDate()	The start date.
ProcessInstanceStateEnum	getState()	Get state
Set<String>	getTags()	List of tags
String	getTenantId()	The tenant ID.
int	hashCode()
ProcessInstanceResult	hasIncident(Boolean hasIncident)
ProcessInstanceResult	parentElementInstanceKey(String parentElementInstanceKey)
ProcessInstanceResult	parentProcessInstanceKey(String parentProcessInstanceKey)
ProcessInstanceResult	processDefinitionId(String processDefinitionId)
ProcessInstanceResult	processDefinitionKey(String processDefinitionKey)
ProcessInstanceResult	processDefinitionName(String processDefinitionName)
ProcessInstanceResult	processDefinitionVersion(Integer processDefinitionVersion)
ProcessInstanceResult	processDefinitionVersionTag(String processDefinitionVersionTag)
ProcessInstanceResult	processInstanceKey(String processInstanceKey)
void	setEndDate(String endDate)
void	setHasIncident(Boolean hasIncident)
void	setParentElementInstanceKey(String parentElementInstanceKey)
void	setParentProcessInstanceKey(String parentProcessInstanceKey)
void	setProcessDefinitionId(String processDefinitionId)
void	setProcessDefinitionKey(String processDefinitionKey)
void	setProcessDefinitionName(String processDefinitionName)
void	setProcessDefinitionVersion(Integer processDefinitionVersion)
void	setProcessDefinitionVersionTag(String processDefinitionVersionTag)
void	setProcessInstanceKey(String processInstanceKey)
void	setStartDate(String startDate)
void	setState(ProcessInstanceStateEnum state)
void	setTags(Set<String> tags)
void	setTenantId(String tenantId)
ProcessInstanceResult	startDate(String startDate)
ProcessInstanceResult	state(ProcessInstanceStateEnum state)
ProcessInstanceResult	tags(Set<String> tags)
ProcessInstanceResult	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.

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

public static final String JSON_PROPERTY_PARENT_ELEMENT_INSTANCE_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_TAGS

public static final String JSON_PROPERTY_TAGS

See Also:

• Constant Field Values

Constructor Details

ProcessInstanceResult

public ProcessInstanceResult()

Method Details

processDefinitionId

public ProcessInstanceResult processDefinitionId(@Nullable
 String processDefinitionId)

getProcessDefinitionId

@Nullable
public String getProcessDefinitionId()

The process definition ID.

Returns:

processDefinitionId

setProcessDefinitionId

public void setProcessDefinitionId(@Nullable
 String processDefinitionId)

processDefinitionName

public ProcessInstanceResult processDefinitionName(@Nullable
 String processDefinitionName)

getProcessDefinitionName

@Nullable
public String getProcessDefinitionName()

The process definition name.

Returns:

processDefinitionName

setProcessDefinitionName

public void setProcessDefinitionName(@Nullable
 String processDefinitionName)

processDefinitionVersion

public ProcessInstanceResult processDefinitionVersion(@Nullable
 Integer processDefinitionVersion)

getProcessDefinitionVersion

@Nullable
public Integer getProcessDefinitionVersion()

The process definition version.

Returns:

processDefinitionVersion

setProcessDefinitionVersion

public void setProcessDefinitionVersion(@Nullable
 Integer processDefinitionVersion)

processDefinitionVersionTag

public ProcessInstanceResult processDefinitionVersionTag(@Nullable
 String processDefinitionVersionTag)

getProcessDefinitionVersionTag

@Nullable
public String getProcessDefinitionVersionTag()

The process definition version tag.

Returns:

processDefinitionVersionTag

setProcessDefinitionVersionTag

public void setProcessDefinitionVersionTag(@Nullable
 String processDefinitionVersionTag)

startDate

public ProcessInstanceResult startDate(@Nullable
 String startDate)

getStartDate

@Nullable
public String getStartDate()

The start date.

Returns:

startDate

setStartDate

public void setStartDate(@Nullable
 String startDate)

endDate

public ProcessInstanceResult endDate(@Nullable
 String endDate)

getEndDate

@Nullable
public String getEndDate()

The end date.

Returns:

endDate

setEndDate

public void setEndDate(@Nullable
 String endDate)

state

public ProcessInstanceResult state(@Nullable
 ProcessInstanceStateEnum state)

getState

@Nullable
public ProcessInstanceStateEnum getState()

Get state

Returns:

state

setState

public void setState(@Nullable
 ProcessInstanceStateEnum state)

hasIncident

public ProcessInstanceResult 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 ProcessInstanceResult tenantId(@Nullable
 String tenantId)

getTenantId

@Nullable
public String getTenantId()

The tenant ID.

Returns:

tenantId

setTenantId

public void setTenantId(@Nullable
 String tenantId)

processInstanceKey

public ProcessInstanceResult processInstanceKey(@Nullable
 String processInstanceKey)

getProcessInstanceKey

@Nullable
public String getProcessInstanceKey()

The key of this process instance.

Returns:

processInstanceKey

setProcessInstanceKey

public void setProcessInstanceKey(@Nullable
 String processInstanceKey)

processDefinitionKey

public ProcessInstanceResult processDefinitionKey(@Nullable
 String processDefinitionKey)

getProcessDefinitionKey

@Nullable
public String getProcessDefinitionKey()

The process definition key.

Returns:

processDefinitionKey

setProcessDefinitionKey

public void setProcessDefinitionKey(@Nullable
 String processDefinitionKey)

parentProcessInstanceKey

public ProcessInstanceResult parentProcessInstanceKey(@Nullable
 String parentProcessInstanceKey)

getParentProcessInstanceKey

@Nullable
public String getParentProcessInstanceKey()

The parent process instance key.

Returns:

parentProcessInstanceKey

setParentProcessInstanceKey

public void setParentProcessInstanceKey(@Nullable
 String parentProcessInstanceKey)

parentElementInstanceKey

public ProcessInstanceResult parentElementInstanceKey(@Nullable
 String parentElementInstanceKey)

getParentElementInstanceKey

@Nullable
public String getParentElementInstanceKey()

The parent element instance key.

Returns:

parentElementInstanceKey

setParentElementInstanceKey

public void setParentElementInstanceKey(@Nullable
 String parentElementInstanceKey)

tags

public ProcessInstanceResult tags(@Nullable
 Set<String> tags)

addTagsItem

public ProcessInstanceResult addTagsItem(String tagsItem)

getTags

@Nullable
public Set<String> getTags()

List of tags

Returns:

tags

setTags

public void setTags(@Nullable
 Set<String> tags)

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