org.openapitools.client.model

Class HistoricProcessInstanceDto

java.lang.Object

org.openapitools.client.model.HistoricProcessInstanceDto

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2022-09-29T11:12:16.359+02:00[Europe/Berlin]")
public class HistoricProcessInstanceDto
extends Object

HistoricProcessInstanceDto

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HistoricProcessInstanceDto.StateEnum Last state of the process instance, possible values are: `ACTIVE` - running process instance `SUSPENDED` - suspended process instances `COMPLETED` - completed through normal end event `EXTERNALLY_TERMINATED` - terminated externally, for instance through REST API `INTERNALLY_TERMINATED` - terminated internally, for instance by terminating boundary event

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_BUSINESS_KEY
static String	SERIALIZED_NAME_CASE_INSTANCE_ID
static String	SERIALIZED_NAME_DELETE_REASON
static String	SERIALIZED_NAME_DURATION_IN_MILLIS
static String	SERIALIZED_NAME_END_TIME
static String	SERIALIZED_NAME_ID
static String	SERIALIZED_NAME_PROCESS_DEFINITION_ID
static String	SERIALIZED_NAME_PROCESS_DEFINITION_KEY
static String	SERIALIZED_NAME_PROCESS_DEFINITION_NAME
static String	SERIALIZED_NAME_PROCESS_DEFINITION_VERSION
static String	SERIALIZED_NAME_REMOVAL_TIME
static String	SERIALIZED_NAME_ROOT_PROCESS_INSTANCE_ID
static String	SERIALIZED_NAME_START_ACTIVITY_ID
static String	SERIALIZED_NAME_START_TIME
static String	SERIALIZED_NAME_START_USER_ID
static String	SERIALIZED_NAME_STATE
static String	SERIALIZED_NAME_SUPER_CASE_INSTANCE_ID
static String	SERIALIZED_NAME_SUPER_PROCESS_INSTANCE_ID
static String	SERIALIZED_NAME_TENANT_ID

Constructor Summary

Constructors

Constructor and Description
HistoricProcessInstanceDto()

Method Summary

Modifier and Type	Method and Description
HistoricProcessInstanceDto	businessKey(String businessKey)
HistoricProcessInstanceDto	caseInstanceId(String caseInstanceId)
HistoricProcessInstanceDto	deleteReason(String deleteReason)
HistoricProcessInstanceDto	durationInMillis(Long durationInMillis)
HistoricProcessInstanceDto	endTime(Date endTime)
boolean	equals(Object o)
String	getBusinessKey() The business key of the process instance.
String	getCaseInstanceId() The id of the parent case instance, if it exists.
String	getDeleteReason() The provided delete reason in case the process instance was canceled during execution.
Long	getDurationInMillis() The time the instance took to finish (in milliseconds).
Date	getEndTime() The time the instance ended.
String	getId() The id of the process instance.
String	getProcessDefinitionId() The id of the process definition that this process instance belongs to.
String	getProcessDefinitionKey() The key of the process definition that this process instance belongs to.
String	getProcessDefinitionName() The name of the process definition that this process instance belongs to.
Integer	getProcessDefinitionVersion() The version of the process definition that this process instance belongs to.
Date	getRemovalTime() The time after which the instance should be removed by the History Cleanup job.
String	getRootProcessInstanceId() The process instance id of the root process instance that initiated the process.
String	getStartActivityId() The id of the initial activity that was executed (e.g., a start event).
Date	getStartTime() The time the instance was started.
String	getStartUserId() The id of the user who started the process instance.
HistoricProcessInstanceDto.StateEnum	getState() Last state of the process instance, possible values are: `ACTIVE` - running process instance `SUSPENDED` - suspended process instances `COMPLETED` - completed through normal end event `EXTERNALLY_TERMINATED` - terminated externally, for instance through REST API `INTERNALLY_TERMINATED` - terminated internally, for instance by terminating boundary event
String	getSuperCaseInstanceId() The id of the parent case instance, if it exists.
String	getSuperProcessInstanceId() The id of the parent process instance, if it exists.
String	getTenantId() The tenant id of the process instance.
int	hashCode()
HistoricProcessInstanceDto	id(String id)
HistoricProcessInstanceDto	processDefinitionId(String processDefinitionId)
HistoricProcessInstanceDto	processDefinitionKey(String processDefinitionKey)
HistoricProcessInstanceDto	processDefinitionName(String processDefinitionName)
HistoricProcessInstanceDto	processDefinitionVersion(Integer processDefinitionVersion)
HistoricProcessInstanceDto	removalTime(Date removalTime)
HistoricProcessInstanceDto	rootProcessInstanceId(String rootProcessInstanceId)
void	setBusinessKey(String businessKey)
void	setCaseInstanceId(String caseInstanceId)
void	setDeleteReason(String deleteReason)
void	setDurationInMillis(Long durationInMillis)
void	setEndTime(Date endTime)
void	setId(String id)
void	setProcessDefinitionId(String processDefinitionId)
void	setProcessDefinitionKey(String processDefinitionKey)
void	setProcessDefinitionName(String processDefinitionName)
void	setProcessDefinitionVersion(Integer processDefinitionVersion)
void	setRemovalTime(Date removalTime)
void	setRootProcessInstanceId(String rootProcessInstanceId)
void	setStartActivityId(String startActivityId)
void	setStartTime(Date startTime)
void	setStartUserId(String startUserId)
void	setState(HistoricProcessInstanceDto.StateEnum state)
void	setSuperCaseInstanceId(String superCaseInstanceId)
void	setSuperProcessInstanceId(String superProcessInstanceId)
void	setTenantId(String tenantId)
HistoricProcessInstanceDto	startActivityId(String startActivityId)
HistoricProcessInstanceDto	startTime(Date startTime)
HistoricProcessInstanceDto	startUserId(String startUserId)
HistoricProcessInstanceDto	state(HistoricProcessInstanceDto.StateEnum state)
HistoricProcessInstanceDto	superCaseInstanceId(String superCaseInstanceId)
HistoricProcessInstanceDto	superProcessInstanceId(String superProcessInstanceId)
HistoricProcessInstanceDto	tenantId(String tenantId)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_ID

public static final String SERIALIZED_NAME_ID

See Also:

Constant Field Values

SERIALIZED_NAME_ROOT_PROCESS_INSTANCE_ID

public static final String SERIALIZED_NAME_ROOT_PROCESS_INSTANCE_ID

See Also:

Constant Field Values

SERIALIZED_NAME_SUPER_PROCESS_INSTANCE_ID

public static final String SERIALIZED_NAME_SUPER_PROCESS_INSTANCE_ID

See Also:

Constant Field Values

SERIALIZED_NAME_SUPER_CASE_INSTANCE_ID

public static final String SERIALIZED_NAME_SUPER_CASE_INSTANCE_ID

See Also:

Constant Field Values

SERIALIZED_NAME_CASE_INSTANCE_ID

public static final String SERIALIZED_NAME_CASE_INSTANCE_ID

See Also:

Constant Field Values

SERIALIZED_NAME_PROCESS_DEFINITION_NAME

public static final String SERIALIZED_NAME_PROCESS_DEFINITION_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_PROCESS_DEFINITION_KEY

public static final String SERIALIZED_NAME_PROCESS_DEFINITION_KEY

See Also:

Constant Field Values

SERIALIZED_NAME_PROCESS_DEFINITION_VERSION

public static final String SERIALIZED_NAME_PROCESS_DEFINITION_VERSION

See Also:

Constant Field Values

SERIALIZED_NAME_PROCESS_DEFINITION_ID

public static final String SERIALIZED_NAME_PROCESS_DEFINITION_ID

See Also:

Constant Field Values

SERIALIZED_NAME_BUSINESS_KEY

public static final String SERIALIZED_NAME_BUSINESS_KEY

See Also:

Constant Field Values

SERIALIZED_NAME_START_TIME

public static final String SERIALIZED_NAME_START_TIME

See Also:

Constant Field Values

SERIALIZED_NAME_END_TIME

public static final String SERIALIZED_NAME_END_TIME

See Also:

Constant Field Values

SERIALIZED_NAME_REMOVAL_TIME

public static final String SERIALIZED_NAME_REMOVAL_TIME

See Also:

Constant Field Values

SERIALIZED_NAME_DURATION_IN_MILLIS

public static final String SERIALIZED_NAME_DURATION_IN_MILLIS

See Also:

Constant Field Values

SERIALIZED_NAME_START_USER_ID

public static final String SERIALIZED_NAME_START_USER_ID

See Also:

Constant Field Values

SERIALIZED_NAME_START_ACTIVITY_ID

public static final String SERIALIZED_NAME_START_ACTIVITY_ID

See Also:

Constant Field Values

SERIALIZED_NAME_DELETE_REASON

public static final String SERIALIZED_NAME_DELETE_REASON

See Also:

Constant Field Values

SERIALIZED_NAME_TENANT_ID

public static final String SERIALIZED_NAME_TENANT_ID

See Also:

Constant Field Values

SERIALIZED_NAME_STATE

public static final String SERIALIZED_NAME_STATE

See Also:

Constant Field Values

Constructor Detail

HistoricProcessInstanceDto

public HistoricProcessInstanceDto()

Method Detail

id

public HistoricProcessInstanceDto id(String id)

getId

@Nullable
public String getId()

The id of the process instance.

Returns:

id

setId

public void setId(String id)

rootProcessInstanceId

public HistoricProcessInstanceDto rootProcessInstanceId(String rootProcessInstanceId)

getRootProcessInstanceId

@Nullable
public String getRootProcessInstanceId()

The process instance id of the root process instance that initiated the process.

Returns:

rootProcessInstanceId

setRootProcessInstanceId

public void setRootProcessInstanceId(String rootProcessInstanceId)

superProcessInstanceId

public HistoricProcessInstanceDto superProcessInstanceId(String superProcessInstanceId)

getSuperProcessInstanceId

@Nullable
public String getSuperProcessInstanceId()

The id of the parent process instance, if it exists.

Returns:

superProcessInstanceId

setSuperProcessInstanceId

public void setSuperProcessInstanceId(String superProcessInstanceId)

superCaseInstanceId

public HistoricProcessInstanceDto superCaseInstanceId(String superCaseInstanceId)

getSuperCaseInstanceId

@Nullable
public String getSuperCaseInstanceId()

The id of the parent case instance, if it exists.

Returns:

superCaseInstanceId

setSuperCaseInstanceId

public void setSuperCaseInstanceId(String superCaseInstanceId)

caseInstanceId

public HistoricProcessInstanceDto caseInstanceId(String caseInstanceId)

getCaseInstanceId

@Nullable
public String getCaseInstanceId()

The id of the parent case instance, if it exists.

Returns:

caseInstanceId

setCaseInstanceId

public void setCaseInstanceId(String caseInstanceId)

processDefinitionName

public HistoricProcessInstanceDto processDefinitionName(String processDefinitionName)

getProcessDefinitionName

@Nullable
public String getProcessDefinitionName()

The name of the process definition that this process instance belongs to.

Returns:

processDefinitionName

setProcessDefinitionName

public void setProcessDefinitionName(String processDefinitionName)

processDefinitionKey

public HistoricProcessInstanceDto processDefinitionKey(String processDefinitionKey)

getProcessDefinitionKey

@Nullable
public String getProcessDefinitionKey()

The key of the process definition that this process instance belongs to.

Returns:

processDefinitionKey

setProcessDefinitionKey

public void setProcessDefinitionKey(String processDefinitionKey)

processDefinitionVersion

public HistoricProcessInstanceDto processDefinitionVersion(Integer processDefinitionVersion)

getProcessDefinitionVersion

@Nullable
public Integer getProcessDefinitionVersion()

The version of the process definition that this process instance belongs to.

Returns:

processDefinitionVersion

setProcessDefinitionVersion

public void setProcessDefinitionVersion(Integer processDefinitionVersion)

processDefinitionId

public HistoricProcessInstanceDto processDefinitionId(String processDefinitionId)

getProcessDefinitionId

@Nullable
public String getProcessDefinitionId()

The id of the process definition that this process instance belongs to.

Returns:

processDefinitionId

setProcessDefinitionId

public void setProcessDefinitionId(String processDefinitionId)

businessKey

public HistoricProcessInstanceDto businessKey(String businessKey)

getBusinessKey

@Nullable
public String getBusinessKey()

The business key of the process instance.

Returns:

businessKey

setBusinessKey

public void setBusinessKey(String businessKey)

startTime

public HistoricProcessInstanceDto startTime(Date startTime)

getStartTime

@Nullable
public Date getStartTime()

The time the instance was started. Default [format](https://docs.camunda.org/manual/7.15/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.

Returns:

startTime

setStartTime

public void setStartTime(Date startTime)

endTime

public HistoricProcessInstanceDto endTime(Date endTime)

getEndTime

@Nullable
public Date getEndTime()

The time the instance ended. Default [format](https://docs.camunda.org/manual/7.15/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.

Returns:

endTime

setEndTime

public void setEndTime(Date endTime)

removalTime

public HistoricProcessInstanceDto removalTime(Date removalTime)

getRemovalTime

@Nullable
public Date getRemovalTime()

The time after which the instance should be removed by the History Cleanup job. Default [format](https://docs.camunda.org/manual/7.15/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.

Returns:

removalTime

setRemovalTime

public void setRemovalTime(Date removalTime)

durationInMillis

public HistoricProcessInstanceDto durationInMillis(Long durationInMillis)

getDurationInMillis

@Nullable
public Long getDurationInMillis()

The time the instance took to finish (in milliseconds).

Returns:

durationInMillis

setDurationInMillis

public void setDurationInMillis(Long durationInMillis)

startUserId

public HistoricProcessInstanceDto startUserId(String startUserId)

getStartUserId

@Nullable
public String getStartUserId()

The id of the user who started the process instance.

Returns:

startUserId

setStartUserId

public void setStartUserId(String startUserId)

startActivityId

public HistoricProcessInstanceDto startActivityId(String startActivityId)

getStartActivityId

@Nullable
public String getStartActivityId()

The id of the initial activity that was executed (e.g., a start event).

Returns:

startActivityId

setStartActivityId

public void setStartActivityId(String startActivityId)

deleteReason

public HistoricProcessInstanceDto deleteReason(String deleteReason)

getDeleteReason

@Nullable
public String getDeleteReason()

The provided delete reason in case the process instance was canceled during execution.

Returns:

deleteReason

setDeleteReason

public void setDeleteReason(String deleteReason)

tenantId

public HistoricProcessInstanceDto tenantId(String tenantId)

getTenantId

@Nullable
public String getTenantId()

The tenant id of the process instance.

Returns:

tenantId

setTenantId

public void setTenantId(String tenantId)

state

public HistoricProcessInstanceDto state(HistoricProcessInstanceDto.StateEnum state)

getState

@Nullable
public HistoricProcessInstanceDto.StateEnum getState()

Last state of the process instance, possible values are: `ACTIVE` - running process instance `SUSPENDED` - suspended process instances `COMPLETED` - completed through normal end event `EXTERNALLY_TERMINATED` - terminated externally, for instance through REST API `INTERNALLY_TERMINATED` - terminated internally, for instance by terminating boundary event

Returns:

state

setState

public void setState(HistoricProcessInstanceDto.StateEnum state)

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