Package io.camunda.client.protocol.rest

Class ProcessInstanceResult

java.lang.Object

io.camunda.client.protocol.rest.ProcessInstanceResult

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.23.0")
public class ProcessInstanceResult
extends Object

Process instance search response item.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_BUSINESS_ID
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_ROOT_PROCESS_INSTANCE_KEY
static final String	JSON_PROPERTY_START_DATE
static final String	JSON_PROPERTY_STATE
static final String	JSON_PROPERTY_SUSPENDED_DATE
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	businessId(String businessId)
ProcessInstanceResult	endDate(String endDate)
boolean	equals(Object o)
String	getBusinessId()	The business id associated with this process instance.
String	getEndDate()	The completion or termination time of the process instance.
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()	Id of a process definition, from the model.
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	getRootProcessInstanceKey()	The key of the root process instance.
String	getStartDate()	The start time of the process instance.
ProcessInstanceStateEnum	getState()	Get state
String	getSuspendedDate()	The time this process instance most recently entered the `SUSPENDED` state.
Set<String>	getTags()	List of tags.
String	getTenantId()	The unique identifier of the tenant.
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)
ProcessInstanceResult	rootProcessInstanceKey(String rootProcessInstanceKey)
void	setBusinessId(String businessId)
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	setRootProcessInstanceKey(String rootProcessInstanceKey)
void	setStartDate(String startDate)
void	setState(ProcessInstanceStateEnum state)
void	setSuspendedDate(String suspendedDate)
void	setTags(Set<String> tags)
void	setTenantId(String tenantId)
ProcessInstanceResult	startDate(String startDate)
ProcessInstanceResult	state(ProcessInstanceStateEnum state)
ProcessInstanceResult	suspendedDate(String suspendedDate)
ProcessInstanceResult	tags(Set<String> tags)
ProcessInstanceResult	tenantId(String tenantId)
String	toString()

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_SUSPENDED_DATE

public static final String JSON_PROPERTY_SUSPENDED_DATE

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_ROOT_PROCESS_INSTANCE_KEY

public static final String JSON_PROPERTY_ROOT_PROCESS_INSTANCE_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_TAGS

public static final String JSON_PROPERTY_TAGS

See Also:

• Constant Field Values

JSON_PROPERTY_BUSINESS_ID

public static final String JSON_PROPERTY_BUSINESS_ID

See Also:

• Constant Field Values

Constructor Details

ProcessInstanceResult

public ProcessInstanceResult()

Method Details

processDefinitionId

public ProcessInstanceResult processDefinitionId(@Nonnull
 String processDefinitionId)

getProcessDefinitionId

@Nonnull
public String getProcessDefinitionId()

Id of a process definition, from the model. Only ids of process definitions that are deployed are useful.

Returns:

processDefinitionId

setProcessDefinitionId

public void setProcessDefinitionId(@Nonnull
 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(@Nonnull
 Integer processDefinitionVersion)

getProcessDefinitionVersion

@Nonnull
public Integer getProcessDefinitionVersion()

The process definition version.

Returns:

processDefinitionVersion

setProcessDefinitionVersion

public void setProcessDefinitionVersion(@Nonnull
 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(@Nonnull
 String startDate)

getStartDate

@Nonnull
public String getStartDate()

The start time of the process instance.

Returns:

startDate

setStartDate

public void setStartDate(@Nonnull
 String startDate)

endDate

public ProcessInstanceResult endDate(@Nullable
 String endDate)

getEndDate

@Nullable
public String getEndDate()

The completion or termination time of the process instance.

Returns:

endDate

setEndDate

public void setEndDate(@Nullable
 String endDate)

state

public ProcessInstanceResult state(@Nonnull
 ProcessInstanceStateEnum state)

getState

@Nonnull
public ProcessInstanceStateEnum getState()

Get state

Returns:

state

setState

public void setState(@Nonnull
 ProcessInstanceStateEnum state)

suspendedDate

public ProcessInstanceResult suspendedDate(@Nullable
 String suspendedDate)

getSuspendedDate

@Nullable
public String getSuspendedDate()

The time this process instance most recently entered the `SUSPENDED` state. This is `null` if the process instance is not currently suspended.

Returns:

suspendedDate

setSuspendedDate

public void setSuspendedDate(@Nullable
 String suspendedDate)

hasIncident

public ProcessInstanceResult hasIncident(@Nonnull
 Boolean hasIncident)

getHasIncident

@Nonnull
public Boolean getHasIncident()

Whether this process instance has a related incident or not.

Returns:

hasIncident

setHasIncident

public void setHasIncident(@Nonnull
 Boolean hasIncident)

tenantId

public ProcessInstanceResult tenantId(@Nonnull
 String tenantId)

getTenantId

@Nonnull
public String getTenantId()

The unique identifier of the tenant.

Returns:

tenantId

setTenantId

public void setTenantId(@Nonnull
 String tenantId)

processInstanceKey

public ProcessInstanceResult processInstanceKey(@Nonnull
 String processInstanceKey)

getProcessInstanceKey

@Nonnull
public String getProcessInstanceKey()

The key of this process instance.

Returns:

processInstanceKey

setProcessInstanceKey

public void setProcessInstanceKey(@Nonnull
 String processInstanceKey)

processDefinitionKey

public ProcessInstanceResult processDefinitionKey(@Nonnull
 String processDefinitionKey)

getProcessDefinitionKey

@Nonnull
public String getProcessDefinitionKey()

The process definition key.

Returns:

processDefinitionKey

setProcessDefinitionKey

public void setProcessDefinitionKey(@Nonnull
 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)

rootProcessInstanceKey

public ProcessInstanceResult rootProcessInstanceKey(@Nullable
 String rootProcessInstanceKey)

getRootProcessInstanceKey

@Nullable
public String getRootProcessInstanceKey()

The key of the root process instance. The root process instance is the top-level ancestor in the process instance hierarchy. This field is only present for data belonging to process instance hierarchies created in version 8.9 or later.

Returns:

rootProcessInstanceKey

setRootProcessInstanceKey

public void setRootProcessInstanceKey(@Nullable
 String rootProcessInstanceKey)

tags

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

addTagsItem

public ProcessInstanceResult addTagsItem(String tagsItem)

getTags

@Nonnull
public Set<String> getTags()

List of tags. Tags need to start with a letter; then alphanumerics, `_`, `-`, `:`, or `.`; length ≤ 100.

Returns:

tags

setTags

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

businessId

public ProcessInstanceResult businessId(@Nullable
 String businessId)

getBusinessId

@Nullable
public String getBusinessId()

The business id associated with this process instance.

Returns:

businessId

setBusinessId

public void setBusinessId(@Nullable
 String businessId)

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