Package org.openapitools.client.model

Class VariableValueDto

java.lang.Object

org.openapitools.client.model.VariableValueDto

public class VariableValueDto
extends Object

VariableValueDto

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERIALIZED_NAME_TYPE
static String	SERIALIZED_NAME_VALUE
static String	SERIALIZED_NAME_VALUE_INFO

Constructor Summary

Constructors

Constructor	Description
VariableValueDto()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
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()
VariableValueDto	putValueInfoItem(String key, Object valueInfoItem)
void	setType(String type)
void	setValue(Object value)
void	setValueInfo(Map<String,Object> valueInfo)
String	toString()
VariableValueDto	type(String type)
VariableValueDto	value(Object value)
VariableValueDto	valueInfo(Map<String,Object> valueInfo)

Methods inherited from class java.lang.Object

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

Field Detail

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

VariableValueDto

public VariableValueDto()

Method Detail

value

public VariableValueDto 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 VariableValueDto type(String type)

getType

public String getType()

The value type of the variable.

Returns:

type

setType

public void setType(String type)

valueInfo

public VariableValueDto valueInfo(Map<String,Object> valueInfo)

putValueInfoItem

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