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

Class ModifyProcessInstanceRequest

java.lang.Object

io.camunda.zeebe.client.protocol.rest.ModifyProcessInstanceRequest

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-10-28T16:53:53.401346729Z[GMT]",
           comments="Generator version: 7.8.0")
public class ModifyProcessInstanceRequest
extends Object

ModifyProcessInstanceRequest

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
ModifyProcessInstanceRequest()

Method Summary

Modifier and Type	Method	Description
ModifyProcessInstanceRequest	activateInstructions(List<ModifyProcessInstanceActivateInstruction> activateInstructions)
ModifyProcessInstanceRequest	addActivateInstructionsItem(ModifyProcessInstanceActivateInstruction activateInstructionsItem)
ModifyProcessInstanceRequest	addTerminateInstructionsItem(ModifyProcessInstanceTerminateInstruction terminateInstructionsItem)
boolean	equals(Object o)
List<ModifyProcessInstanceActivateInstruction>	getActivateInstructions()	Get activateInstructions
Long	getOperationReference()	A reference key chosen by the user that will be part of all records resulting from this operation.
List<ModifyProcessInstanceTerminateInstruction>	getTerminateInstructions()	Get terminateInstructions
int	hashCode()
ModifyProcessInstanceRequest	operationReference(Long operationReference)
void	setActivateInstructions(List<ModifyProcessInstanceActivateInstruction> activateInstructions)
void	setOperationReference(Long operationReference)
void	setTerminateInstructions(List<ModifyProcessInstanceTerminateInstruction> terminateInstructions)
ModifyProcessInstanceRequest	terminateInstructions(List<ModifyProcessInstanceTerminateInstruction> 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_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

JSON_PROPERTY_OPERATION_REFERENCE

public static final String JSON_PROPERTY_OPERATION_REFERENCE

See Also:

• Constant Field Values

Constructor Details

ModifyProcessInstanceRequest

public ModifyProcessInstanceRequest()

Method Details

activateInstructions

public ModifyProcessInstanceRequest activateInstructions(List<ModifyProcessInstanceActivateInstruction> activateInstructions)

addActivateInstructionsItem

public ModifyProcessInstanceRequest addActivateInstructionsItem(ModifyProcessInstanceActivateInstruction activateInstructionsItem)

getActivateInstructions

@Nullable
public List<ModifyProcessInstanceActivateInstruction> getActivateInstructions()

Get activateInstructions

Returns:

activateInstructions

setActivateInstructions

public void setActivateInstructions(List<ModifyProcessInstanceActivateInstruction> activateInstructions)

terminateInstructions

public ModifyProcessInstanceRequest terminateInstructions(List<ModifyProcessInstanceTerminateInstruction> terminateInstructions)

addTerminateInstructionsItem

public ModifyProcessInstanceRequest addTerminateInstructionsItem(ModifyProcessInstanceTerminateInstruction terminateInstructionsItem)

getTerminateInstructions

@Nullable
public List<ModifyProcessInstanceTerminateInstruction> getTerminateInstructions()

Get terminateInstructions

Returns:

terminateInstructions

setTerminateInstructions

public void setTerminateInstructions(List<ModifyProcessInstanceTerminateInstruction> terminateInstructions)

operationReference

public ModifyProcessInstanceRequest operationReference(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(Long operationReference)

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