Package io.camunda.client.protocol.rest

Class ModifyProcessInstanceVariableInstruction

java.lang.Object

io.camunda.client.protocol.rest.ModifyProcessInstanceVariableInstruction

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2025-02-25T13:39:08.081076719Z[GMT]",
           comments="Generator version: 7.10.0")
public class ModifyProcessInstanceVariableInstruction
extends Object

Instructions describing which variables should be created.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_SCOPE_ID
static final String	JSON_PROPERTY_VARIABLES

Constructor Summary

Constructors

Constructor	Description
ModifyProcessInstanceVariableInstruction()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getScopeId()	The ID of the element in which scope the variables should be created.
Map<String,Object>	getVariables()	JSON document that will instantiate the variables for the root variable scope of the process instance.
int	hashCode()
ModifyProcessInstanceVariableInstruction	putVariablesItem(String key, Object variablesItem)
ModifyProcessInstanceVariableInstruction	scopeId(String scopeId)
void	setScopeId(String scopeId)
void	setVariables(Map<String,Object> variables)
String	toString()
String	toUrlQueryString()	Convert the instance into URL query string.
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.
ModifyProcessInstanceVariableInstruction	variables(Map<String,Object> variables)

Methods inherited from class java.lang.Object

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

Field Details

JSON_PROPERTY_VARIABLES

public static final String JSON_PROPERTY_VARIABLES

See Also:

• Constant Field Values

JSON_PROPERTY_SCOPE_ID

public static final String JSON_PROPERTY_SCOPE_ID

See Also:

• Constant Field Values

Constructor Details

ModifyProcessInstanceVariableInstruction

public ModifyProcessInstanceVariableInstruction()

Method Details

variables

public ModifyProcessInstanceVariableInstruction variables(@Nonnull
 Map<String,Object> variables)

putVariablesItem

public ModifyProcessInstanceVariableInstruction putVariablesItem(String key,
 Object variablesItem)

getVariables

@Nonnull
public Map<String,Object> getVariables()

JSON document that will instantiate the variables for the root variable scope of the process instance. It must be a JSON object, as variables will be mapped in a key-value fashion.

Returns:

variables

setVariables

public void setVariables(@Nonnull
 Map<String,Object> variables)

scopeId

public ModifyProcessInstanceVariableInstruction scopeId(@Nullable
 String scopeId)

getScopeId

@Nullable
public String getScopeId()

The ID of the element in which scope the variables should be created. Leave empty to create the variables in the global scope of the process instance

Returns:

scopeId

setScopeId

public void setScopeId(@Nullable
 String scopeId)

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