Package io.camunda.zeebe.client.protocol.rest

Class ProcessInstanceResult

java.lang.Object

io.camunda.zeebe.client.protocol.rest.ProcessInstanceResult

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

ProcessInstanceResult

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ProcessInstanceResult.StateEnum	Gets or Sets state

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_BPMN_PROCESS_ID
static final String	JSON_PROPERTY_CALL_HIERARCHY
static final String	JSON_PROPERTY_END_DATE
static final String	JSON_PROPERTY_HAS_ACTIVE_OPERATION
static final String	JSON_PROPERTY_INCIDENT
static final String	JSON_PROPERTY_KEY
static final String	JSON_PROPERTY_OPERATIONS
static final String	JSON_PROPERTY_PARENT_FLOW_NODE_INSTANCE_KEY
static final String	JSON_PROPERTY_PARENT_KEY
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_ROOT_INSTANCE_ID
static final String	JSON_PROPERTY_START_DATE
static final String	JSON_PROPERTY_STATE
static final String	JSON_PROPERTY_TENANT_ID

Constructor Summary

Constructors

Constructor	Description
ProcessInstanceResult()

Method Summary

Modifier and Type	Method	Description
ProcessInstanceResult	addCallHierarchyItem(ProcessInstanceReferenceItem callHierarchyItem)
ProcessInstanceResult	addOperationsItem(OperationItem operationsItem)
ProcessInstanceResult	bpmnProcessId(String bpmnProcessId)
ProcessInstanceResult	callHierarchy(List<ProcessInstanceReferenceItem> callHierarchy)
ProcessInstanceResult	endDate(String endDate)
boolean	equals(Object o)
String	getBpmnProcessId()	Get bpmnProcessId
List<ProcessInstanceReferenceItem>	getCallHierarchy()	Get callHierarchy
String	getEndDate()	Get endDate
Boolean	getHasActiveOperation()	Get hasActiveOperation
Boolean	getIncident()	Get incident
String	getKey()	Get key
List<OperationItem>	getOperations()	Get operations
String	getParentFlowNodeInstanceKey()	Get parentFlowNodeInstanceKey
String	getParentKey()	Get parentKey
String	getProcessDefinitionKey()	Get processDefinitionKey
String	getProcessDefinitionName()	The process name.
Integer	getProcessDefinitionVersion()	Get processDefinitionVersion
String	getRootInstanceId()	Get rootInstanceId
String	getStartDate()	Get startDate
ProcessInstanceResult.StateEnum	getState()	Get state
String	getTenantId()	Get tenantId
ProcessInstanceResult	hasActiveOperation(Boolean hasActiveOperation)
int	hashCode()
ProcessInstanceResult	incident(Boolean incident)
ProcessInstanceResult	key(String key)
ProcessInstanceResult	operations(List<OperationItem> operations)
ProcessInstanceResult	parentFlowNodeInstanceKey(String parentFlowNodeInstanceKey)
ProcessInstanceResult	parentKey(String parentKey)
ProcessInstanceResult	processDefinitionKey(String processDefinitionKey)
ProcessInstanceResult	processDefinitionName(String processDefinitionName)
ProcessInstanceResult	processDefinitionVersion(Integer processDefinitionVersion)
ProcessInstanceResult	rootInstanceId(String rootInstanceId)
void	setBpmnProcessId(String bpmnProcessId)
void	setCallHierarchy(List<ProcessInstanceReferenceItem> callHierarchy)
void	setEndDate(String endDate)
void	setHasActiveOperation(Boolean hasActiveOperation)
void	setIncident(Boolean incident)
void	setKey(String key)
void	setOperations(List<OperationItem> operations)
void	setParentFlowNodeInstanceKey(String parentFlowNodeInstanceKey)
void	setParentKey(String parentKey)
void	setProcessDefinitionKey(String processDefinitionKey)
void	setProcessDefinitionName(String processDefinitionName)
void	setProcessDefinitionVersion(Integer processDefinitionVersion)
void	setRootInstanceId(String rootInstanceId)
void	setStartDate(String startDate)
void	setState(ProcessInstanceResult.StateEnum state)
void	setTenantId(String tenantId)
ProcessInstanceResult	startDate(String startDate)
ProcessInstanceResult	state(ProcessInstanceResult.StateEnum state)
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_KEY

public static final String JSON_PROPERTY_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_PARENT_KEY

public static final String JSON_PROPERTY_PARENT_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_PARENT_FLOW_NODE_INSTANCE_KEY

public static final String JSON_PROPERTY_PARENT_FLOW_NODE_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_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_BPMN_PROCESS_ID

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

public static final String JSON_PROPERTY_STATE

See Also:

• Constant Field Values

JSON_PROPERTY_INCIDENT

public static final String JSON_PROPERTY_INCIDENT

See Also:

• Constant Field Values

JSON_PROPERTY_HAS_ACTIVE_OPERATION

public static final String JSON_PROPERTY_HAS_ACTIVE_OPERATION

See Also:

• Constant Field Values

JSON_PROPERTY_TENANT_ID

public static final String JSON_PROPERTY_TENANT_ID

See Also:

• Constant Field Values

JSON_PROPERTY_ROOT_INSTANCE_ID

public static final String JSON_PROPERTY_ROOT_INSTANCE_ID

See Also:

• Constant Field Values

JSON_PROPERTY_OPERATIONS

public static final String JSON_PROPERTY_OPERATIONS

See Also:

• Constant Field Values

JSON_PROPERTY_CALL_HIERARCHY

public static final String JSON_PROPERTY_CALL_HIERARCHY

See Also:

• Constant Field Values

Constructor Details

ProcessInstanceResult

public ProcessInstanceResult()

Method Details

key

public ProcessInstanceResult key(String key)

getKey

@Nullable
public String getKey()

Get key

Returns:

key

setKey

public void setKey(String key)

parentKey

public ProcessInstanceResult parentKey(String parentKey)

getParentKey

@Nullable
public String getParentKey()

Get parentKey

Returns:

parentKey

setParentKey

public void setParentKey(String parentKey)

parentFlowNodeInstanceKey

public ProcessInstanceResult parentFlowNodeInstanceKey(String parentFlowNodeInstanceKey)

getParentFlowNodeInstanceKey

@Nullable
public String getParentFlowNodeInstanceKey()

Get parentFlowNodeInstanceKey

Returns:

parentFlowNodeInstanceKey

setParentFlowNodeInstanceKey

public void setParentFlowNodeInstanceKey(String parentFlowNodeInstanceKey)

processDefinitionKey

public ProcessInstanceResult processDefinitionKey(String processDefinitionKey)

getProcessDefinitionKey

@Nullable
public String getProcessDefinitionKey()

Get processDefinitionKey

Returns:

processDefinitionKey

setProcessDefinitionKey

public void setProcessDefinitionKey(String processDefinitionKey)

processDefinitionName

public ProcessInstanceResult processDefinitionName(String processDefinitionName)

getProcessDefinitionName

@Nullable
public String getProcessDefinitionName()

The process name.

Returns:

processDefinitionName

setProcessDefinitionName

public void setProcessDefinitionName(String processDefinitionName)

processDefinitionVersion

public ProcessInstanceResult processDefinitionVersion(Integer processDefinitionVersion)

getProcessDefinitionVersion

@Nullable
public Integer getProcessDefinitionVersion()

Get processDefinitionVersion

Returns:

processDefinitionVersion

setProcessDefinitionVersion

public void setProcessDefinitionVersion(Integer processDefinitionVersion)

bpmnProcessId

public ProcessInstanceResult bpmnProcessId(String bpmnProcessId)

getBpmnProcessId

@Nullable
public String getBpmnProcessId()

Get bpmnProcessId

Returns:

bpmnProcessId

setBpmnProcessId

public void setBpmnProcessId(String bpmnProcessId)

startDate

public ProcessInstanceResult startDate(String startDate)

getStartDate

@Nullable
public String getStartDate()

Get startDate

Returns:

startDate

setStartDate

public void setStartDate(String startDate)

endDate

public ProcessInstanceResult endDate(String endDate)

getEndDate

@Nullable
public String getEndDate()

Get endDate

Returns:

endDate

setEndDate

public void setEndDate(String endDate)

state

public ProcessInstanceResult state(ProcessInstanceResult.StateEnum state)

getState

@Nullable
public ProcessInstanceResult.StateEnum getState()

Get state

Returns:

state

setState

public void setState(ProcessInstanceResult.StateEnum state)

incident

public ProcessInstanceResult incident(Boolean incident)

getIncident

@Nullable
public Boolean getIncident()

Get incident

Returns:

incident

setIncident

public void setIncident(Boolean incident)

hasActiveOperation

public ProcessInstanceResult hasActiveOperation(Boolean hasActiveOperation)

getHasActiveOperation

@Nullable
public Boolean getHasActiveOperation()

Get hasActiveOperation

Returns:

hasActiveOperation

setHasActiveOperation

public void setHasActiveOperation(Boolean hasActiveOperation)

tenantId

public ProcessInstanceResult tenantId(String tenantId)

getTenantId

@Nullable
public String getTenantId()

Get tenantId

Returns:

tenantId

setTenantId

public void setTenantId(String tenantId)

rootInstanceId

public ProcessInstanceResult rootInstanceId(String rootInstanceId)

getRootInstanceId

@Nullable
public String getRootInstanceId()

Get rootInstanceId

Returns:

rootInstanceId

setRootInstanceId

public void setRootInstanceId(String rootInstanceId)

operations

public ProcessInstanceResult operations(List<OperationItem> operations)

addOperationsItem

public ProcessInstanceResult addOperationsItem(OperationItem operationsItem)

getOperations

@Nullable
public List<OperationItem> getOperations()

Get operations

Returns:

operations

setOperations

public void setOperations(List<OperationItem> operations)

callHierarchy

public ProcessInstanceResult callHierarchy(List<ProcessInstanceReferenceItem> callHierarchy)

addCallHierarchyItem

public ProcessInstanceResult addCallHierarchyItem(ProcessInstanceReferenceItem callHierarchyItem)

getCallHierarchy

@Nullable
public List<ProcessInstanceReferenceItem> getCallHierarchy()

Get callHierarchy

Returns:

callHierarchy

setCallHierarchy

public void setCallHierarchy(List<ProcessInstanceReferenceItem> callHierarchy)

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