Package io.camunda.zeebe.client.api.command

Interface MigrateProcessInstanceCommandStep1

All Superinterfaces:

CommandWithCommunicationApiStep<MigrateProcessInstanceCommandStep1>

All Known Implementing Classes:

MigrateProcessInstanceCommandImpl

@ExperimentalApi("https://github.com/camunda/camunda/issues/14907")
public interface MigrateProcessInstanceCommandStep1
extends CommandWithCommunicationApiStep<MigrateProcessInstanceCommandStep1>

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	MigrateProcessInstanceCommandStep1.MigrateProcessInstanceCommandFinalStep
static interface	MigrateProcessInstanceCommandStep1.MigrateProcessInstanceCommandStep2

Method Summary

Modifier and Type	Method	Description
MigrateProcessInstanceCommandStep1.MigrateProcessInstanceCommandStep2	migrationPlan(long targetProcessDefinitionKey)	Create a MigrationPlan GatewayOuterClass.MigrateProcessInstanceRequest.MigrationPlan for the given target process definition key.
MigrateProcessInstanceCommandStep1.MigrateProcessInstanceCommandFinalStep	migrationPlan(MigrationPlan migrationPlan)	Use the provided MigrationPlan from the given MigrationPlan object.

Methods inherited from interface io.camunda.zeebe.client.api.command.CommandWithCommunicationApiStep

useGrpc, useRest

Method Details

migrationPlan

MigrateProcessInstanceCommandStep1.MigrateProcessInstanceCommandStep2 migrationPlan(long targetProcessDefinitionKey)

Create a MigrationPlan GatewayOuterClass.MigrateProcessInstanceRequest.MigrationPlan for the given target process definition key.

Parameters:

targetProcessDefinitionKey - the key of the target process definition

Returns:

the builder for this command

migrationPlan

MigrateProcessInstanceCommandStep1.MigrateProcessInstanceCommandFinalStep migrationPlan(MigrationPlan migrationPlan)

Use the provided MigrationPlan from the given MigrationPlan object.

Example MigrationPlan object creation:

 final MigrationPlan migrationPlan =
         MigrationPlan.newBuilder()
             .withTargetProcessDefinitionKey(2L)
             .addMappingInstruction("element1", "element2")
             .addMappingInstruction("element3", "element4")
             .build();
 

Parameters:

migrationPlan - the object that contains migration plan data

Returns:

the builder for this command