Package io.camunda.client.protocol.rest

Class ProcessInstanceModificationInstruction

java.lang.Object

io.camunda.client.protocol.rest.ProcessInstanceModificationInstruction

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

ProcessInstanceModificationInstruction

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_ACTIVATE_INSTRUCTIONS
static final String	JSON_PROPERTY_OPERATION_REFERENCE
static final String	JSON_PROPERTY_TERMINATE_INSTRUCTIONS

Constructor Summary

Constructors

Constructor	Description
ProcessInstanceModificationInstruction()

Method Summary

Modifier and Type	Method	Description
ProcessInstanceModificationInstruction	activateInstructions(List<ProcessInstanceModificationActivateInstruction> activateInstructions)
ProcessInstanceModificationInstruction	addActivateInstructionsItem(ProcessInstanceModificationActivateInstruction activateInstructionsItem)
ProcessInstanceModificationInstruction	addTerminateInstructionsItem(ProcessInstanceModificationTerminateInstruction terminateInstructionsItem)
boolean	equals(Object o)
List<ProcessInstanceModificationActivateInstruction>	getActivateInstructions()	Instructions describing which elements should be activated in which scopes and which variables should be created.
Long	getOperationReference()	A reference key chosen by the user that will be part of all records resulting from this operation.
List<ProcessInstanceModificationTerminateInstruction>	getTerminateInstructions()	Instructions describing which elements should be terminated.
int	hashCode()
ProcessInstanceModificationInstruction	operationReference(Long operationReference)
void	setActivateInstructions(List<ProcessInstanceModificationActivateInstruction> activateInstructions)
void	setOperationReference(Long operationReference)
void	setTerminateInstructions(List<ProcessInstanceModificationTerminateInstruction> terminateInstructions)
ProcessInstanceModificationInstruction	terminateInstructions(List<ProcessInstanceModificationTerminateInstruction> terminateInstructions)
String	toString()
String	toUrlQueryString()	Convert the instance into URL query string.
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.

Methods inherited from class java.lang.Object

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

Field Details

JSON_PROPERTY_OPERATION_REFERENCE

public static final String JSON_PROPERTY_OPERATION_REFERENCE

See Also:

• Constant Field Values

JSON_PROPERTY_ACTIVATE_INSTRUCTIONS

public static final String JSON_PROPERTY_ACTIVATE_INSTRUCTIONS

See Also:

• Constant Field Values

JSON_PROPERTY_TERMINATE_INSTRUCTIONS

public static final String JSON_PROPERTY_TERMINATE_INSTRUCTIONS

See Also:

• Constant Field Values

Constructor Details

ProcessInstanceModificationInstruction

public ProcessInstanceModificationInstruction()

Method Details

operationReference

public ProcessInstanceModificationInstruction operationReference(@Nullable
 Long operationReference)

getOperationReference

@Nullable
public Long getOperationReference()

A reference key chosen by the user that will be part of all records resulting from this operation. Must be > 0 if provided. minimum: 1

Returns:

operationReference

setOperationReference

public void setOperationReference(@Nullable
 Long operationReference)

activateInstructions

public ProcessInstanceModificationInstruction activateInstructions(@Nullable
 List<ProcessInstanceModificationActivateInstruction> activateInstructions)

addActivateInstructionsItem

public ProcessInstanceModificationInstruction addActivateInstructionsItem(ProcessInstanceModificationActivateInstruction activateInstructionsItem)

getActivateInstructions

@Nullable
public List<ProcessInstanceModificationActivateInstruction> getActivateInstructions()

Instructions describing which elements should be activated in which scopes and which variables should be created.

Returns:

activateInstructions

setActivateInstructions

public void setActivateInstructions(@Nullable
 List<ProcessInstanceModificationActivateInstruction> activateInstructions)

terminateInstructions

public ProcessInstanceModificationInstruction terminateInstructions(@Nullable
 List<ProcessInstanceModificationTerminateInstruction> terminateInstructions)

addTerminateInstructionsItem

public ProcessInstanceModificationInstruction addTerminateInstructionsItem(ProcessInstanceModificationTerminateInstruction terminateInstructionsItem)

getTerminateInstructions

@Nullable
public List<ProcessInstanceModificationTerminateInstruction> getTerminateInstructions()

Instructions describing which elements should be terminated.

Returns:

terminateInstructions

setTerminateInstructions

public void setTerminateInstructions(@Nullable
 List<ProcessInstanceModificationTerminateInstruction> terminateInstructions)

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