java.lang.Object
- org.openapitools.client.model.HistoricVariableInstanceDto

public class HistoricVariableInstanceDto
extends Object

HistoricVariableInstanceDto

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`SERIALIZED_NAME_ACTIVITY_INSTANCE_ID`
`static String`	`SERIALIZED_NAME_CASE_DEFINITION_ID`
`static String`	`SERIALIZED_NAME_CASE_DEFINITION_KEY`
`static String`	`SERIALIZED_NAME_CASE_EXECUTION_ID`
`static String`	`SERIALIZED_NAME_CASE_INSTANCE_ID`
`static String`	`SERIALIZED_NAME_CREATE_TIME`
`static String`	`SERIALIZED_NAME_ERROR_MESSAGE`
`static String`	`SERIALIZED_NAME_EXECUTION_ID`
`static String`	`SERIALIZED_NAME_ID`
`static String`	`SERIALIZED_NAME_NAME`
`static String`	`SERIALIZED_NAME_PROCESS_DEFINITION_ID`
`static String`	`SERIALIZED_NAME_PROCESS_DEFINITION_KEY`
`static String`	`SERIALIZED_NAME_PROCESS_INSTANCE_ID`
`static String`	`SERIALIZED_NAME_REMOVAL_TIME`
`static String`	`SERIALIZED_NAME_ROOT_PROCESS_INSTANCE_ID`
`static String`	`SERIALIZED_NAME_STATE`
`static String`	`SERIALIZED_NAME_TASK_ID`
`static String`	`SERIALIZED_NAME_TENANT_ID`
`static String`	`SERIALIZED_NAME_TYPE`
`static String`	`SERIALIZED_NAME_VALUE`
`static String`	`SERIALIZED_NAME_VALUE_INFO`

Constructor Summary

Constructors
Constructor Description

HistoricVariableInstanceDto()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`HistoricVariableInstanceDto`	`activityInstanceId(String activityInstanceId)`
`HistoricVariableInstanceDto`	`caseDefinitionId(String caseDefinitionId)`
`HistoricVariableInstanceDto`	`caseDefinitionKey(String caseDefinitionKey)`
`HistoricVariableInstanceDto`	`caseExecutionId(String caseExecutionId)`
`HistoricVariableInstanceDto`	`caseInstanceId(String caseInstanceId)`
`HistoricVariableInstanceDto`	`createTime(Date createTime)`
`boolean`	`equals(Object o)`
`HistoricVariableInstanceDto`	`errorMessage(String errorMessage)`
`HistoricVariableInstanceDto`	`executionId(String executionId)`
`String`	`getActivityInstanceId()`	The id of the activity instance in which the variable is valid.
`String`	`getCaseDefinitionId()`	The id of the case definition the variable instance belongs to.
`String`	`getCaseDefinitionKey()`	The key of the case definition the variable instance belongs to.
`String`	`getCaseExecutionId()`	The case execution id the variable instance belongs to.
`String`	`getCaseInstanceId()`	The case instance id the variable instance belongs to.
`Date`	`getCreateTime()`	The time the variable was inserted.
`String`	`getErrorMessage()`	An error message in case a Java Serialized Object could not be de-serialized.
`String`	`getExecutionId()`	The execution id the variable instance belongs to.
`String`	`getId()`	The id of the variable instance.
`String`	`getName()`	The name of the variable instance.
`String`	`getProcessDefinitionId()`	The id of the process definition the variable instance belongs to.
`String`	`getProcessDefinitionKey()`	The key of the process definition the variable instance belongs to.
`String`	`getProcessInstanceId()`	The process instance id the variable instance belongs to.
`Date`	`getRemovalTime()`	The time after which the variable should be removed by the History Cleanup job.
`String`	`getRootProcessInstanceId()`	The process instance id of the root process instance that initiated the process containing this variable.
`String`	`getState()`	The current state of the variable.
`String`	`getTaskId()`	The id of the task the variable instance belongs to.
`String`	`getTenantId()`	The id of the tenant that this variable instance belongs to.
`String`	`getType()`	The value type of the variable.
`Object`	`getValue()`	Can be any value - string, number, boolean, array or object.
`Map<String,Object>`	`getValueInfo()`	A JSON object containing additional, value-type-dependent properties.
`int`	`hashCode()`
`HistoricVariableInstanceDto`	`id(String id)`
`HistoricVariableInstanceDto`	`name(String name)`
`HistoricVariableInstanceDto`	`processDefinitionId(String processDefinitionId)`
`HistoricVariableInstanceDto`	`processDefinitionKey(String processDefinitionKey)`
`HistoricVariableInstanceDto`	`processInstanceId(String processInstanceId)`
`HistoricVariableInstanceDto`	`putValueInfoItem(String key, Object valueInfoItem)`
`HistoricVariableInstanceDto`	`removalTime(Date removalTime)`
`HistoricVariableInstanceDto`	`rootProcessInstanceId(String rootProcessInstanceId)`
`void`	`setActivityInstanceId(String activityInstanceId)`
`void`	`setCaseDefinitionId(String caseDefinitionId)`
`void`	`setCaseDefinitionKey(String caseDefinitionKey)`
`void`	`setCaseExecutionId(String caseExecutionId)`
`void`	`setCaseInstanceId(String caseInstanceId)`
`void`	`setCreateTime(Date createTime)`
`void`	`setErrorMessage(String errorMessage)`
`void`	`setExecutionId(String executionId)`
`void`	`setId(String id)`
`void`	`setName(String name)`
`void`	`setProcessDefinitionId(String processDefinitionId)`
`void`	`setProcessDefinitionKey(String processDefinitionKey)`
`void`	`setProcessInstanceId(String processInstanceId)`
`void`	`setRemovalTime(Date removalTime)`
`void`	`setRootProcessInstanceId(String rootProcessInstanceId)`
`void`	`setState(String state)`
`void`	`setTaskId(String taskId)`
`void`	`setTenantId(String tenantId)`
`void`	`setType(String type)`
`void`	`setValue(Object value)`
`void`	`setValueInfo(Map<String,Object> valueInfo)`
`HistoricVariableInstanceDto`	`state(String state)`
`HistoricVariableInstanceDto`	`taskId(String taskId)`
`HistoricVariableInstanceDto`	`tenantId(String tenantId)`
`String`	`toString()`
`HistoricVariableInstanceDto`	`type(String type)`
`HistoricVariableInstanceDto`	`value(Object value)`
`HistoricVariableInstanceDto`	`valueInfo(Map<String,Object> valueInfo)`

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_NAME
```
public static final String SERIALIZED_NAME_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_ID
```
public static final String SERIALIZED_NAME_PROCESS_DEFINITION_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PROCESS_INSTANCE_ID
```
public static final String SERIALIZED_NAME_PROCESS_INSTANCE_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_EXECUTION_ID
```
public static final String SERIALIZED_NAME_EXECUTION_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ACTIVITY_INSTANCE_ID
```
public static final String SERIALIZED_NAME_ACTIVITY_INSTANCE_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CASE_DEFINITION_KEY
```
public static final String SERIALIZED_NAME_CASE_DEFINITION_KEY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CASE_DEFINITION_ID
```
public static final String SERIALIZED_NAME_CASE_DEFINITION_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_CASE_EXECUTION_ID
```
public static final String SERIALIZED_NAME_CASE_EXECUTION_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TASK_ID
```
public static final String SERIALIZED_NAME_TASK_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TENANT_ID
```
public static final String SERIALIZED_NAME_TENANT_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ERROR_MESSAGE
```
public static final String SERIALIZED_NAME_ERROR_MESSAGE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_STATE
```
public static final String SERIALIZED_NAME_STATE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CREATE_TIME
```
public static final String SERIALIZED_NAME_CREATE_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_ROOT_PROCESS_INSTANCE_ID
```
public static final String SERIALIZED_NAME_ROOT_PROCESS_INSTANCE_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_VALUE
```
public static final String SERIALIZED_NAME_VALUE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TYPE
```
public static final String SERIALIZED_NAME_TYPE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_VALUE_INFO
```
public static final String SERIALIZED_NAME_VALUE_INFO
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HistoricVariableInstanceDto
```
public HistoricVariableInstanceDto()
```
- Method Detail
  - id
```
public HistoricVariableInstanceDto id(String id)
```
  - getId
```
public String getId()
```
    The id of the variable instance.
    
    Returns:
    
    id
  - setId
```
public void setId(String id)
```
  - name
```
public HistoricVariableInstanceDto name(String name)
```
  - getName
```
public String getName()
```
    The name of the variable instance.
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
  - processDefinitionKey
```
public HistoricVariableInstanceDto processDefinitionKey(String processDefinitionKey)
```
  - getProcessDefinitionKey
```
public String getProcessDefinitionKey()
```
    The key of the process definition the variable instance belongs to.
    
    Returns:
    
    processDefinitionKey
  - setProcessDefinitionKey
```
public void setProcessDefinitionKey(String processDefinitionKey)
```
  - processDefinitionId
```
public HistoricVariableInstanceDto processDefinitionId(String processDefinitionId)
```
  - getProcessDefinitionId
```
public String getProcessDefinitionId()
```
    The id of the process definition the variable instance belongs to.
    
    Returns:
    
    processDefinitionId
  - setProcessDefinitionId
```
public void setProcessDefinitionId(String processDefinitionId)
```
  - processInstanceId
```
public HistoricVariableInstanceDto processInstanceId(String processInstanceId)
```
  - getProcessInstanceId
```
public String getProcessInstanceId()
```
    The process instance id the variable instance belongs to.
    
    Returns:
    
    processInstanceId
  - setProcessInstanceId
```
public void setProcessInstanceId(String processInstanceId)
```
  - executionId
```
public HistoricVariableInstanceDto executionId(String executionId)
```
  - getExecutionId
```
public String getExecutionId()
```
    The execution id the variable instance belongs to.
    
    Returns:
    
    executionId
  - setExecutionId
```
public void setExecutionId(String executionId)
```
  - activityInstanceId
```
public HistoricVariableInstanceDto activityInstanceId(String activityInstanceId)
```
  - getActivityInstanceId
```
public String getActivityInstanceId()
```
    The id of the activity instance in which the variable is valid.
    
    Returns:
    
    activityInstanceId
  - setActivityInstanceId
```
public void setActivityInstanceId(String activityInstanceId)
```
  - caseDefinitionKey
```
public HistoricVariableInstanceDto caseDefinitionKey(String caseDefinitionKey)
```
  - getCaseDefinitionKey
```
public String getCaseDefinitionKey()
```
    The key of the case definition the variable instance belongs to.
    
    Returns:
    
    caseDefinitionKey
  - setCaseDefinitionKey
```
public void setCaseDefinitionKey(String caseDefinitionKey)
```
  - caseDefinitionId
```
public HistoricVariableInstanceDto caseDefinitionId(String caseDefinitionId)
```
  - getCaseDefinitionId
```
public String getCaseDefinitionId()
```
    The id of the case definition the variable instance belongs to.
    
    Returns:
    
    caseDefinitionId
  - setCaseDefinitionId
```
public void setCaseDefinitionId(String caseDefinitionId)
```
  - caseInstanceId
```
public HistoricVariableInstanceDto caseInstanceId(String caseInstanceId)
```
  - getCaseInstanceId
```
public String getCaseInstanceId()
```
    The case instance id the variable instance belongs to.
    
    Returns:
    
    caseInstanceId
  - setCaseInstanceId
```
public void setCaseInstanceId(String caseInstanceId)
```
  - caseExecutionId
```
public HistoricVariableInstanceDto caseExecutionId(String caseExecutionId)
```
  - getCaseExecutionId
```
public String getCaseExecutionId()
```
    The case execution id the variable instance belongs to.
    
    Returns:
    
    caseExecutionId
  - setCaseExecutionId
```
public void setCaseExecutionId(String caseExecutionId)
```
  - taskId
```
public HistoricVariableInstanceDto taskId(String taskId)
```
  - getTaskId
```
public String getTaskId()
```
    The id of the task the variable instance belongs to.
    
    Returns:
    
    taskId
  - setTaskId
```
public void setTaskId(String taskId)
```
  - tenantId
```
public HistoricVariableInstanceDto tenantId(String tenantId)
```
  - getTenantId
```
public String getTenantId()
```
    The id of the tenant that this variable instance belongs to.
    
    Returns:
    
    tenantId
  - setTenantId
```
public void setTenantId(String tenantId)
```
  - errorMessage
```
public HistoricVariableInstanceDto errorMessage(String errorMessage)
```
  - getErrorMessage
```
public String getErrorMessage()
```
    An error message in case a Java Serialized Object could not be de-serialized.
    
    Returns:
    
    errorMessage
  - setErrorMessage
```
public void setErrorMessage(String errorMessage)
```
  - state
```
public HistoricVariableInstanceDto state(String state)
```
  - getState
```
public String getState()
```
    The current state of the variable. Can be 'CREATED' or 'DELETED'.
    
    Returns:
    
    state
  - setState
```
public void setState(String state)
```
  - createTime
```
public HistoricVariableInstanceDto createTime(Date createTime)
```
  - getCreateTime
```
public Date getCreateTime()
```
    The time the variable was inserted. [Default format](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
    
    Returns:
    
    createTime
  - setCreateTime
```
public void setCreateTime(Date createTime)
```
  - removalTime
```
public HistoricVariableInstanceDto removalTime(Date removalTime)
```
  - getRemovalTime
```
public Date getRemovalTime()
```
    The time after which the variable should be removed by the History Cleanup job. [Default format](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
    
    Returns:
    
    removalTime
  - setRemovalTime
```
public void setRemovalTime(Date removalTime)
```
  - rootProcessInstanceId
```
public HistoricVariableInstanceDto rootProcessInstanceId(String rootProcessInstanceId)
```
  - getRootProcessInstanceId
```
public String getRootProcessInstanceId()
```
    The process instance id of the root process instance that initiated the process containing this variable.
    
    Returns:
    
    rootProcessInstanceId
  - setRootProcessInstanceId
```
public void setRootProcessInstanceId(String rootProcessInstanceId)
```
  - value
```
public HistoricVariableInstanceDto value(Object value)
```
  - getValue
```
public Object getValue()
```
    Can be any value - string, number, boolean, array or object. **Note**: Not every endpoint supports every type.
    
    Returns:
    
    value
  - setValue
```
public void setValue(Object value)
```
  - type
```
public HistoricVariableInstanceDto type(String type)
```
  - getType
```
public String getType()
```
    The value type of the variable.
    
    Returns:
    
    type
  - setType
```
public void setType(String type)
```
  - valueInfo
```
public HistoricVariableInstanceDto valueInfo(Map<String,Object> valueInfo)
```
  - putValueInfoItem
```
public HistoricVariableInstanceDto putValueInfoItem(String key,
                                                    Object valueInfoItem)
```
  - getValueInfo
```
public Map<String,Object> getValueInfo()
```
    A JSON object containing additional, value-type-dependent properties. For serialized variables of type Object, the following properties can be provided: * `objectTypeName`: A string representation of the object's type name. * `serializationDataFormat`: The serialization format used to store the variable. For serialized variables of type File, the following properties can be provided: * `filename`: The name of the file. This is not the variable name but the name that will be used when downloading the file again. * `mimetype`: The MIME type of the file that is being uploaded. * `encoding`: The encoding of the file that is being uploaded. The following property can be provided for all value types: * `transient`: Indicates whether the variable should be transient or not. See [documentation](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables#transient-variables) for more informations. (Not applicable for `decision-definition`, ` /process-instance/variables-async`, and `/migration/executeAsync` endpoints)
    
    Returns:
    
    valueInfo
  - setValueInfo
```
public void setValueInfo(Map<String,Object> valueInfo)
```
  - 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

Class HistoricVariableInstanceDto

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_ID

SERIALIZED_NAME_NAME

SERIALIZED_NAME_PROCESS_DEFINITION_KEY

SERIALIZED_NAME_PROCESS_DEFINITION_ID

SERIALIZED_NAME_PROCESS_INSTANCE_ID

SERIALIZED_NAME_EXECUTION_ID

SERIALIZED_NAME_ACTIVITY_INSTANCE_ID

SERIALIZED_NAME_CASE_DEFINITION_KEY

SERIALIZED_NAME_CASE_DEFINITION_ID

SERIALIZED_NAME_CASE_INSTANCE_ID

SERIALIZED_NAME_CASE_EXECUTION_ID

SERIALIZED_NAME_TASK_ID

SERIALIZED_NAME_TENANT_ID

SERIALIZED_NAME_ERROR_MESSAGE

SERIALIZED_NAME_STATE

SERIALIZED_NAME_CREATE_TIME

SERIALIZED_NAME_REMOVAL_TIME

SERIALIZED_NAME_ROOT_PROCESS_INSTANCE_ID

SERIALIZED_NAME_VALUE

SERIALIZED_NAME_TYPE

SERIALIZED_NAME_VALUE_INFO

Constructor Detail

HistoricVariableInstanceDto

Method Detail

id

getId

setId

name

getName

setName

processDefinitionKey

getProcessDefinitionKey

setProcessDefinitionKey

processDefinitionId

getProcessDefinitionId

setProcessDefinitionId

processInstanceId

getProcessInstanceId

setProcessInstanceId

executionId

getExecutionId

setExecutionId

activityInstanceId

getActivityInstanceId

setActivityInstanceId

caseDefinitionKey

getCaseDefinitionKey

setCaseDefinitionKey

caseDefinitionId

getCaseDefinitionId

setCaseDefinitionId

caseInstanceId

getCaseInstanceId

setCaseInstanceId

caseExecutionId

getCaseExecutionId

setCaseExecutionId

taskId

getTaskId

setTaskId

tenantId

getTenantId

setTenantId

errorMessage

getErrorMessage

setErrorMessage

state

getState

setState

createTime

getCreateTime

setCreateTime

removalTime

getRemovalTime