Package io.camunda.zeebe.client.protocol.rest

Class ProcessInstanceModificationActivateInstruction

java.lang.Object

io.camunda.zeebe.client.protocol.rest.ProcessInstanceModificationActivateInstruction

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2025-08-04T12:37:47.170113265Z[GMT]",
           comments="Generator version: 7.8.0")
public class ProcessInstanceModificationActivateInstruction
extends Object

Instructions describing which elements should be activated in which scopes and which variables should be created. Key attributes as string values.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_ANCESTOR_ELEMENT_INSTANCE_KEY
static final String	JSON_PROPERTY_ELEMENT_ID
static final String	JSON_PROPERTY_VARIABLE_INSTRUCTIONS

Constructor Summary

Constructors

Constructor	Description
ProcessInstanceModificationActivateInstruction()

Method Summary

Modifier and Type	Method	Description
ProcessInstanceModificationActivateInstruction	addVariableInstructionsItem(ModifyProcessInstanceVariableInstruction variableInstructionsItem)
ProcessInstanceModificationActivateInstruction	ancestorElementInstanceKey(String ancestorElementInstanceKey)
ProcessInstanceModificationActivateInstruction	elementId(String elementId)
boolean	equals(Object o)
String	getAncestorElementInstanceKey()	The key of the ancestor scope the element instance should be created in.
String	getElementId()	The ID of the element that should be activated.
List<ModifyProcessInstanceVariableInstruction>	getVariableInstructions()	Get variableInstructions
int	hashCode()
void	setAncestorElementInstanceKey(String ancestorElementInstanceKey)
void	setElementId(String elementId)
void	setVariableInstructions(List<ModifyProcessInstanceVariableInstruction> variableInstructions)
String	toString()
String	toUrlQueryString()	Convert the instance into URL query string.
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.
ProcessInstanceModificationActivateInstruction	variableInstructions(List<ModifyProcessInstanceVariableInstruction> variableInstructions)

Methods inherited from class java.lang.Object

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

Field Details

JSON_PROPERTY_ANCESTOR_ELEMENT_INSTANCE_KEY

public static final String JSON_PROPERTY_ANCESTOR_ELEMENT_INSTANCE_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_ELEMENT_ID

public static final String JSON_PROPERTY_ELEMENT_ID

See Also:

• Constant Field Values

JSON_PROPERTY_VARIABLE_INSTRUCTIONS

public static final String JSON_PROPERTY_VARIABLE_INSTRUCTIONS

See Also:

• Constant Field Values

Constructor Details

ProcessInstanceModificationActivateInstruction

public ProcessInstanceModificationActivateInstruction()

Method Details

ancestorElementInstanceKey

public ProcessInstanceModificationActivateInstruction ancestorElementInstanceKey(String ancestorElementInstanceKey)

getAncestorElementInstanceKey

@Nullable
public String getAncestorElementInstanceKey()

The key of the ancestor scope the element instance should be created in. Set to -1 to create the new element instance within an existing element instance of the flow scope.

Returns:

ancestorElementInstanceKey

setAncestorElementInstanceKey

public void setAncestorElementInstanceKey(String ancestorElementInstanceKey)

elementId

public ProcessInstanceModificationActivateInstruction elementId(String elementId)

getElementId

@Nonnull
public String getElementId()

The ID of the element that should be activated.

Returns:

elementId

setElementId

public void setElementId(String elementId)

variableInstructions

public ProcessInstanceModificationActivateInstruction variableInstructions(List<ModifyProcessInstanceVariableInstruction> variableInstructions)

addVariableInstructionsItem

public ProcessInstanceModificationActivateInstruction addVariableInstructionsItem(ModifyProcessInstanceVariableInstruction variableInstructionsItem)

getVariableInstructions

@Nullable
public List<ModifyProcessInstanceVariableInstruction> getVariableInstructions()

Get variableInstructions

Returns:

variableInstructions

setVariableInstructions

public void setVariableInstructions(List<ModifyProcessInstanceVariableInstruction> variableInstructions)

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