VariableInstanceDto (Camunda Platform Javadocs 7.15.19-ee)

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

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

VariableInstanceDto

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_ACTIVITY_INSTANCE_ID`
`static String`	`SERIALIZED_NAME_BATCH_ID`
`static String`	`SERIALIZED_NAME_CASE_EXECUTION_ID`
`static String`	`SERIALIZED_NAME_CASE_INSTANCE_ID`
`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_INSTANCE_ID`
`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 and Description

VariableInstanceDto()

Constructors
Constructor and Description
`VariableInstanceDto()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`VariableInstanceDto`	`activityInstanceId(String activityInstanceId)`
`VariableInstanceDto`	`batchId(String batchId)`
`VariableInstanceDto`	`caseExecutionId(String caseExecutionId)`
`VariableInstanceDto`	`caseInstanceId(String caseInstanceId)`
`boolean`	`equals(Object o)`
`VariableInstanceDto`	`errorMessage(String errorMessage)`
`VariableInstanceDto`	`executionId(String executionId)`
`String`	`getActivityInstanceId()` The id of the activity instance that this variable instance belongs to.
`String`	`getBatchId()` The id of the batch that this variable instance belongs to.<
`String`	`getCaseExecutionId()` The id of the case execution that this variable instance belongs to.
`String`	`getCaseInstanceId()` The id of the case instance that this variable instance belongs to.
`String`	`getErrorMessage()` An error message in case a Java Serialized Object could not be de-serialized.
`String`	`getExecutionId()` The id of the execution that this 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 that this variable instance belongs to.
`String`	`getProcessInstanceId()` The id of the process instance that this variable instance belongs to.
`String`	`getTaskId()` The id of the task that this 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()`
`VariableInstanceDto`	`id(String id)`
`VariableInstanceDto`	`name(String name)`
`VariableInstanceDto`	`processDefinitionId(String processDefinitionId)`
`VariableInstanceDto`	`processInstanceId(String processInstanceId)`
`VariableInstanceDto`	`putValueInfoItem(String key, Object valueInfoItem)`
`void`	`setActivityInstanceId(String activityInstanceId)`
`void`	`setBatchId(String batchId)`
`void`	`setCaseExecutionId(String caseExecutionId)`
`void`	`setCaseInstanceId(String caseInstanceId)`
`void`	`setErrorMessage(String errorMessage)`
`void`	`setExecutionId(String executionId)`
`void`	`setId(String id)`
`void`	`setName(String name)`
`void`	`setProcessDefinitionId(String processDefinitionId)`
`void`	`setProcessInstanceId(String processInstanceId)`
`void`	`setTaskId(String taskId)`
`void`	`setTenantId(String tenantId)`
`void`	`setType(String type)`
`void`	`setValue(Object value)`
`void`	`setValueInfo(Map<String,Object> valueInfo)`
`VariableInstanceDto`	`taskId(String taskId)`
`VariableInstanceDto`	`tenantId(String tenantId)`
`String`	`toString()`
`VariableInstanceDto`	`type(String type)`
`VariableInstanceDto`	`value(Object value)`
`VariableInstanceDto`	`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_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_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_BATCH_ID
```
public static final String SERIALIZED_NAME_BATCH_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_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_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
  - VariableInstanceDto
```
public VariableInstanceDto()
```
- Method Detail
  - id
```
public VariableInstanceDto id(String id)
```
  - getId
```
@Nullable
public String getId()
```
    The id of the variable instance.
    
    Returns:
    
    id
  - setId
```
public void setId(String id)
```
  - name
```
public VariableInstanceDto name(String name)
```
  - getName
```
@Nullable
public String getName()
```
    The name of the variable instance.
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
  - processDefinitionId
```
public VariableInstanceDto processDefinitionId(String processDefinitionId)
```
  - getProcessDefinitionId
```
@Nullable
public String getProcessDefinitionId()
```
    The id of the process definition that this variable instance belongs to.
    
    Returns:
    
    processDefinitionId
  - setProcessDefinitionId
```
public void setProcessDefinitionId(String processDefinitionId)
```
  - processInstanceId
```
public VariableInstanceDto processInstanceId(String processInstanceId)
```
  - getProcessInstanceId
```
@Nullable
public String getProcessInstanceId()
```
    The id of the process instance that this variable instance belongs to.
    
    Returns:
    
    processInstanceId
  - setProcessInstanceId
```
public void setProcessInstanceId(String processInstanceId)
```
  - executionId
```
public VariableInstanceDto executionId(String executionId)
```
  - getExecutionId
```
@Nullable
public String getExecutionId()
```
    The id of the execution that this variable instance belongs to.
    
    Returns:
    
    executionId
  - setExecutionId
```
public void setExecutionId(String executionId)
```
  - caseInstanceId
```
public VariableInstanceDto caseInstanceId(String caseInstanceId)
```
  - getCaseInstanceId
```
@Nullable
public String getCaseInstanceId()
```
    The id of the case instance that this variable instance belongs to.
    
    Returns:
    
    caseInstanceId
  - setCaseInstanceId
```
public void setCaseInstanceId(String caseInstanceId)
```
  - caseExecutionId
```
public VariableInstanceDto caseExecutionId(String caseExecutionId)
```
  - getCaseExecutionId
```
@Nullable
public String getCaseExecutionId()
```
    The id of the case execution that this variable instance belongs to.
    
    Returns:
    
    caseExecutionId
  - setCaseExecutionId
```
public void setCaseExecutionId(String caseExecutionId)
```
  - taskId
```
public VariableInstanceDto taskId(String taskId)
```
  - getTaskId
```
@Nullable
public String getTaskId()
```
    The id of the task that this variable instance belongs to.
    
    Returns:
    
    taskId
  - setTaskId
```
public void setTaskId(String taskId)
```
  - batchId
```
public VariableInstanceDto batchId(String batchId)
```
  - getBatchId
```
@Nullable
public String getBatchId()
```
    The id of the batch that this variable instance belongs to.<
    
    Returns:
    
    batchId
  - setBatchId
```
public void setBatchId(String batchId)
```
  - activityInstanceId
```
public VariableInstanceDto activityInstanceId(String activityInstanceId)
```
  - getActivityInstanceId
```
@Nullable
public String getActivityInstanceId()
```
    The id of the activity instance that this variable instance belongs to.
    
    Returns:
    
    activityInstanceId
  - setActivityInstanceId
```
public void setActivityInstanceId(String activityInstanceId)
```
  - tenantId
```
public VariableInstanceDto tenantId(String tenantId)
```
  - getTenantId
```
@Nullable
public String getTenantId()
```
    The id of the tenant that this variable instance belongs to.
    
    Returns:
    
    tenantId
  - setTenantId
```
public void setTenantId(String tenantId)
```
  - errorMessage
```
public VariableInstanceDto errorMessage(String errorMessage)
```
  - getErrorMessage
```
@Nullable
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)
```
  - value
```
public VariableInstanceDto value(Object value)
```
  - getValue
```
@Nullable
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 VariableInstanceDto type(String type)
```
  - getType
```
@Nullable
public String getType()
```
    The value type of the variable.
    
    Returns:
    
    type
  - setType
```
public void setType(String type)
```
  - valueInfo
```
public VariableInstanceDto valueInfo(Map<String,Object> valueInfo)
```
  - putValueInfoItem
```
public VariableInstanceDto putValueInfoItem(String key,
                                            Object valueInfoItem)
```
  - getValueInfo
```
@Nullable
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.15/user-guide/process-engine/variables#transient-variables) for more informations. (Not applicable for `decision-definition` and ` /process-instance/variables-async` 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 VariableInstanceDto

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_ID

SERIALIZED_NAME_PROCESS_INSTANCE_ID

SERIALIZED_NAME_EXECUTION_ID

SERIALIZED_NAME_CASE_INSTANCE_ID

SERIALIZED_NAME_CASE_EXECUTION_ID

SERIALIZED_NAME_TASK_ID

SERIALIZED_NAME_BATCH_ID

SERIALIZED_NAME_ACTIVITY_INSTANCE_ID

SERIALIZED_NAME_TENANT_ID

SERIALIZED_NAME_ERROR_MESSAGE

SERIALIZED_NAME_VALUE

SERIALIZED_NAME_TYPE

SERIALIZED_NAME_VALUE_INFO

Constructor Detail

VariableInstanceDto

Method Detail

id

getId

setId

name

getName

setName

processDefinitionId

getProcessDefinitionId

setProcessDefinitionId

processInstanceId

getProcessInstanceId

setProcessInstanceId

executionId

getExecutionId

setExecutionId

caseInstanceId

getCaseInstanceId

setCaseInstanceId

caseExecutionId

getCaseExecutionId

setCaseExecutionId

taskId

getTaskId

setTaskId

batchId

getBatchId

setBatchId

activityInstanceId

getActivityInstanceId

setActivityInstanceId

tenantId

getTenantId

setTenantId

errorMessage

getErrorMessage

setErrorMessage

value

getValue

setValue

type

getType

setType

valueInfo

putValueInfoItem

getValueInfo

setValueInfo

equals

hashCode

toString