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

Class ProcessInstanceItem

java.lang.Object

io.camunda.zeebe.client.protocol.rest.ProcessInstanceItem

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-10-11T12:21:29.045272383Z[GMT]",
           comments="Generator version: 7.8.0")
public class ProcessInstanceItem
extends Object

ProcessInstanceItem

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
ProcessInstanceItem	addCallHierarchyItem(ProcessInstanceReferenceItem callHierarchyItem)
ProcessInstanceItem	addOperationsItem(OperationItem operationsItem)
ProcessInstanceItem	bpmnProcessId(String bpmnProcessId)
ProcessInstanceItem	callHierarchy(List<ProcessInstanceReferenceItem> callHierarchy)
ProcessInstanceItem	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
Long	getKey()	Get key
List<OperationItem>	getOperations()	Get operations
Long	getParentFlowNodeInstanceKey()	Get parentFlowNodeInstanceKey
Long	getParentKey()	Get parentKey
Long	getProcessDefinitionKey()	Get processDefinitionKey
String	getProcessDefinitionName()	The process name.
Integer	getProcessDefinitionVersion()	Get processDefinitionVersion
String	getRootInstanceId()	Get rootInstanceId
String	getStartDate()	Get startDate
ProcessInstanceItem.StateEnum	getState()	Get state
String	getTenantId()	Get tenantId
ProcessInstanceItem	hasActiveOperation(Boolean hasActiveOperation)
int	hashCode()
ProcessInstanceItem	incident(Boolean incident)
ProcessInstanceItem	key(Long key)
ProcessInstanceItem	operations(List<OperationItem> operations)
ProcessInstanceItem	parentFlowNodeInstanceKey(Long parentFlowNodeInstanceKey)
ProcessInstanceItem	parentKey(Long parentKey)
ProcessInstanceItem	processDefinitionKey(Long processDefinitionKey)
ProcessInstanceItem	processDefinitionName(String processDefinitionName)
ProcessInstanceItem	processDefinitionVersion(Integer processDefinitionVersion)
ProcessInstanceItem	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(Long key)
void	setOperations(List<OperationItem> operations)
void	setParentFlowNodeInstanceKey(Long parentFlowNodeInstanceKey)
void	setParentKey(Long parentKey)
void	setProcessDefinitionKey(Long processDefinitionKey)
void	setProcessDefinitionName(String processDefinitionName)
void	setProcessDefinitionVersion(Integer processDefinitionVersion)
void	setRootInstanceId(String rootInstanceId)
void	setStartDate(String startDate)
void	setState(ProcessInstanceItem.StateEnum state)
void	setTenantId(String tenantId)
ProcessInstanceItem	startDate(String startDate)
ProcessInstanceItem	state(ProcessInstanceItem.StateEnum state)
ProcessInstanceItem	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_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_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_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_PROCESS_DEFINITION_KEY

public static final String JSON_PROPERTY_PROCESS_DEFINITION_KEY

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

ProcessInstanceItem

public ProcessInstanceItem()

Method Details

key

public ProcessInstanceItem key(Long key)

getKey

@Nullable
public Long getKey()

Get key

Returns:

key

setKey

public void setKey(Long key)

processDefinitionName

public ProcessInstanceItem processDefinitionName(String processDefinitionName)

getProcessDefinitionName

@Nullable
public String getProcessDefinitionName()

The process name.

Returns:

processDefinitionName

setProcessDefinitionName

public void setProcessDefinitionName(String processDefinitionName)

processDefinitionVersion

public ProcessInstanceItem processDefinitionVersion(Integer processDefinitionVersion)

getProcessDefinitionVersion

@Nullable
public Integer getProcessDefinitionVersion()

Get processDefinitionVersion

Returns:

processDefinitionVersion

setProcessDefinitionVersion

public void setProcessDefinitionVersion(Integer processDefinitionVersion)

bpmnProcessId

public ProcessInstanceItem bpmnProcessId(String bpmnProcessId)

getBpmnProcessId

@Nullable
public String getBpmnProcessId()

Get bpmnProcessId

Returns:

bpmnProcessId

setBpmnProcessId

public void setBpmnProcessId(String bpmnProcessId)

parentKey

public ProcessInstanceItem parentKey(Long parentKey)

getParentKey

@Nullable
public Long getParentKey()

Get parentKey

Returns:

parentKey

setParentKey

public void setParentKey(Long parentKey)

parentFlowNodeInstanceKey

public ProcessInstanceItem parentFlowNodeInstanceKey(Long parentFlowNodeInstanceKey)

getParentFlowNodeInstanceKey

@Nullable
public Long getParentFlowNodeInstanceKey()

Get parentFlowNodeInstanceKey

Returns:

parentFlowNodeInstanceKey

setParentFlowNodeInstanceKey

public void setParentFlowNodeInstanceKey(Long parentFlowNodeInstanceKey)

startDate

public ProcessInstanceItem startDate(String startDate)

getStartDate

@Nullable
public String getStartDate()

Get startDate

Returns:

startDate

setStartDate

public void setStartDate(String startDate)

endDate

public ProcessInstanceItem endDate(String endDate)

getEndDate

@Nullable
public String getEndDate()

Get endDate

Returns:

endDate

setEndDate

public void setEndDate(String endDate)

state

public ProcessInstanceItem state(ProcessInstanceItem.StateEnum state)

getState

@Nullable
public ProcessInstanceItem.StateEnum getState()

Get state

Returns:

state

setState

public void setState(ProcessInstanceItem.StateEnum state)

incident

public ProcessInstanceItem incident(Boolean incident)

getIncident

@Nullable
public Boolean getIncident()

Get incident

Returns:

incident

setIncident

public void setIncident(Boolean incident)

hasActiveOperation

public ProcessInstanceItem hasActiveOperation(Boolean hasActiveOperation)

getHasActiveOperation

@Nullable
public Boolean getHasActiveOperation()

Get hasActiveOperation

Returns:

hasActiveOperation

setHasActiveOperation

public void setHasActiveOperation(Boolean hasActiveOperation)

processDefinitionKey

public ProcessInstanceItem processDefinitionKey(Long processDefinitionKey)

getProcessDefinitionKey

@Nullable
public Long getProcessDefinitionKey()

Get processDefinitionKey

Returns:

processDefinitionKey

setProcessDefinitionKey

public void setProcessDefinitionKey(Long processDefinitionKey)

tenantId

public ProcessInstanceItem tenantId(String tenantId)

getTenantId

@Nullable
public String getTenantId()

Get tenantId

Returns:

tenantId

setTenantId

public void setTenantId(String tenantId)

rootInstanceId

public ProcessInstanceItem rootInstanceId(String rootInstanceId)

getRootInstanceId

@Nullable
public String getRootInstanceId()

Get rootInstanceId

Returns:

rootInstanceId

setRootInstanceId

public void setRootInstanceId(String rootInstanceId)

operations

public ProcessInstanceItem operations(List<OperationItem> operations)

addOperationsItem

public ProcessInstanceItem addOperationsItem(OperationItem operationsItem)

getOperations

@Nullable
public List<OperationItem> getOperations()

Get operations

Returns:

operations

setOperations

public void setOperations(List<OperationItem> operations)

callHierarchy

public ProcessInstanceItem callHierarchy(List<ProcessInstanceReferenceItem> callHierarchy)

addCallHierarchyItem

public ProcessInstanceItem 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