Package io.camunda.client.protocol.rest

Class ProcessInstanceMigrationInstruction

java.lang.Object

io.camunda.client.protocol.rest.ProcessInstanceMigrationInstruction

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2025-10-08T19:37:20.302687113Z[GMT]",
           comments="Generator version: 7.12.0")
public class ProcessInstanceMigrationInstruction
extends Object

The migration instructions describe how to migrate a process instance from one process definition to another.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_MAPPING_INSTRUCTIONS
static final String	JSON_PROPERTY_OPERATION_REFERENCE
static final String	JSON_PROPERTY_TARGET_PROCESS_DEFINITION_KEY

Constructor Summary

Constructors

Constructor	Description
ProcessInstanceMigrationInstruction()

Method Summary

Modifier and Type	Method	Description
ProcessInstanceMigrationInstruction	addMappingInstructionsItem(MigrateProcessInstanceMappingInstruction mappingInstructionsItem)
boolean	equals(Object o)
List<MigrateProcessInstanceMappingInstruction>	getMappingInstructions()	Element mappings from the source process instance to the target process instance.
Long	getOperationReference()	A reference key chosen by the user that will be part of all records resulting from this operation.
String	getTargetProcessDefinitionKey()	The key of process definition to migrate the process instance to.
int	hashCode()
ProcessInstanceMigrationInstruction	mappingInstructions(List<MigrateProcessInstanceMappingInstruction> mappingInstructions)
ProcessInstanceMigrationInstruction	operationReference(Long operationReference)
void	setMappingInstructions(List<MigrateProcessInstanceMappingInstruction> mappingInstructions)
void	setOperationReference(Long operationReference)
void	setTargetProcessDefinitionKey(String targetProcessDefinitionKey)
ProcessInstanceMigrationInstruction	targetProcessDefinitionKey(String targetProcessDefinitionKey)
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_MAPPING_INSTRUCTIONS

public static final String JSON_PROPERTY_MAPPING_INSTRUCTIONS

See Also:

• Constant Field Values

JSON_PROPERTY_OPERATION_REFERENCE

public static final String JSON_PROPERTY_OPERATION_REFERENCE

See Also:

• Constant Field Values

JSON_PROPERTY_TARGET_PROCESS_DEFINITION_KEY

public static final String JSON_PROPERTY_TARGET_PROCESS_DEFINITION_KEY

See Also:

• Constant Field Values

Constructor Details

ProcessInstanceMigrationInstruction

public ProcessInstanceMigrationInstruction()

Method Details

mappingInstructions

public ProcessInstanceMigrationInstruction mappingInstructions(@Nonnull
 List<MigrateProcessInstanceMappingInstruction> mappingInstructions)

addMappingInstructionsItem

public ProcessInstanceMigrationInstruction addMappingInstructionsItem(MigrateProcessInstanceMappingInstruction mappingInstructionsItem)

getMappingInstructions

@Nonnull
public List<MigrateProcessInstanceMappingInstruction> getMappingInstructions()

Element mappings from the source process instance to the target process instance.

Returns:

mappingInstructions

setMappingInstructions

public void setMappingInstructions(@Nonnull
 List<MigrateProcessInstanceMappingInstruction> mappingInstructions)

operationReference

public ProcessInstanceMigrationInstruction 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)

targetProcessDefinitionKey

public ProcessInstanceMigrationInstruction targetProcessDefinitionKey(@Nonnull
 String targetProcessDefinitionKey)

getTargetProcessDefinitionKey

@Nonnull
public String getTargetProcessDefinitionKey()

The key of process definition to migrate the process instance to.

Returns:

targetProcessDefinitionKey

setTargetProcessDefinitionKey

public void setTargetProcessDefinitionKey(@Nonnull
 String targetProcessDefinitionKey)

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