Package io.camunda.zeebe.client.impl.command

Class ModifyProcessInstanceCommandImpl

java.lang.Object

io.camunda.zeebe.client.impl.command.ModifyProcessInstanceCommandImpl

All Implemented Interfaces:

FinalCommandStep<ModifyProcessInstanceResponse>, ModifyProcessInstanceCommandStep1, ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep2, ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3

public final class ModifyProcessInstanceCommandImpl
extends Object
implements ModifyProcessInstanceCommandStep1, ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3

Nested Class Summary

Nested classes/interfaces inherited from interface io.camunda.zeebe.client.api.command.ModifyProcessInstanceCommandStep1

ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep2, ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3

Constructor Summary

Constructors

Constructor	Description
ModifyProcessInstanceCommandImpl(long processInstanceKey, JsonMapper jsonMapper, GatewayGrpc.GatewayStub asyncStub, Duration requestTimeout, Predicate<Throwable> retryPredicate)

Method Summary

Modifier and Type	Method	Description
ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3	activateElement(String elementId)	Create an GatewayOuterClass.ModifyProcessInstanceRequest.ActivateInstruction for the given element id.
ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3	activateElement(String elementId, long ancestorElementInstanceKey)	Create an GatewayOuterClass.ModifyProcessInstanceRequest.ActivateInstruction for the given element id.
ModifyProcessInstanceCommandStep1	and()	Acts as a boundary between the different activate and terminate instructions.
FinalCommandStep<ModifyProcessInstanceResponse>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
ZeebeFuture<ModifyProcessInstanceResponse>	send()	Sends the command to the Zeebe broker.
ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep2	terminateElement(long elementInstanceKey)	Create a GatewayOuterClass.ModifyProcessInstanceRequest.TerminateInstruction for the given element id.
ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3	withVariables(InputStream variables)	Create a GatewayOuterClass.ModifyProcessInstanceRequest.VariableInstruction for the element that's getting activated.
ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3	withVariables(InputStream variables, String scopeId)	Create a GatewayOuterClass.ModifyProcessInstanceRequest.VariableInstruction for the element that's getting activated.
ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3	withVariables(Object variables)	Create a GatewayOuterClass.ModifyProcessInstanceRequest.VariableInstruction for the element that's getting activated.
ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3	withVariables(Object variables, String scopeId)	Create a GatewayOuterClass.ModifyProcessInstanceRequest.VariableInstruction for the element that's getting activated.
ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3	withVariables(String variables)	Create a GatewayOuterClass.ModifyProcessInstanceRequest.VariableInstruction for the element that's getting activated.
ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3	withVariables(String variables, String scopeId)	Create a GatewayOuterClass.ModifyProcessInstanceRequest.VariableInstruction for the element that's getting activated.
ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3	withVariables(Map<String,Object> variables)	Create a GatewayOuterClass.ModifyProcessInstanceRequest.VariableInstruction for the element that's getting activated.
ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3	withVariables(Map<String,Object> variables, String scopeId)	Create a GatewayOuterClass.ModifyProcessInstanceRequest.VariableInstruction for the element that's getting activated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ModifyProcessInstanceCommandImpl

public ModifyProcessInstanceCommandImpl(long processInstanceKey,
 JsonMapper jsonMapper,
 GatewayGrpc.GatewayStub asyncStub,
 Duration requestTimeout,
 Predicate<Throwable> retryPredicate)

Method Details

activateElement

public ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3 activateElement(String elementId)

Description copied from interface: ModifyProcessInstanceCommandStep1

Create an GatewayOuterClass.ModifyProcessInstanceRequest.ActivateInstruction for the given element id. The element will be created within an existing element instance of the flow scope. When activating an element inside a multi-instance element the element instance key of the ancestor must be defined. For this use ModifyProcessInstanceCommandStep1.activateElement(String, long).

Specified by:

activateElement in interface ModifyProcessInstanceCommandStep1

Parameters:

elementId - the id of the element to activate

Returns:

the builder for this command

activateElement

public ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3 activateElement(String elementId,
 long ancestorElementInstanceKey)

Description copied from interface: ModifyProcessInstanceCommandStep1

Create an GatewayOuterClass.ModifyProcessInstanceRequest.ActivateInstruction for the given element id. The element will be created within the scope that is passed. This scope must be an ancestor of the element that's getting activated.

Specified by:

activateElement in interface ModifyProcessInstanceCommandStep1

Parameters:

elementId - the id of the element to activate

ancestorElementInstanceKey - the element instance key in which the element will be created

Returns:

the builder for this command

terminateElement

public ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep2 terminateElement(long elementInstanceKey)

Description copied from interface: ModifyProcessInstanceCommandStep1

Create a GatewayOuterClass.ModifyProcessInstanceRequest.TerminateInstruction for the given element id.

Specified by:

terminateElement in interface ModifyProcessInstanceCommandStep1

Parameters:

elementInstanceKey - the element instance key of the element to termiante

Returns:

the builder for this command

and

public ModifyProcessInstanceCommandStep1 and()

Description copied from interface: ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep2

Acts as a boundary between the different activate and terminate instructions. Use this if you want to activate or terminate another element. Otherwise, FinalCommandStep.send() the command.

Specified by:

and in interface ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep2

Returns:

the builder for this command

withVariables

public ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3 withVariables(InputStream variables)

Description copied from interface: ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3

Create a GatewayOuterClass.ModifyProcessInstanceRequest.VariableInstruction for the element that's getting activated. These variables will be created in the global scope of the process instance.

Specified by:

withVariables in interface ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3

Parameters:

variables - the variables JSON document as stream

Returns:

the builder for this command

withVariables

public ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3 withVariables(InputStream variables,
 String scopeId)

Description copied from interface: ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3

Create a GatewayOuterClass.ModifyProcessInstanceRequest.VariableInstruction for the element that's getting activated. These variables will be created in the scope of the passed element.

Specified by:

withVariables in interface ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3

Parameters:

variables - the variables JSON document as stream

scopeId - the id of the element in which scope the variables should be created

Returns:

the builder for this command

withVariables

public ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3 withVariables(String variables)

Description copied from interface: ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3

Create a GatewayOuterClass.ModifyProcessInstanceRequest.VariableInstruction for the element that's getting activated. These variables will be created in the global scope of the process instance.

Specified by:

withVariables in interface ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3

Parameters:

variables - the variables JSON document as String

Returns:

the builder for this command

withVariables

public ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3 withVariables(String variables,
 String scopeId)

Description copied from interface: ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3

Create a GatewayOuterClass.ModifyProcessInstanceRequest.VariableInstruction for the element that's getting activated. These variables will be created in the scope of the passed element.

Specified by:

withVariables in interface ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3

Parameters:

variables - the variables JSON document as String

scopeId - the id of the element in which scope the variables should be created

Returns:

the builder for this command

withVariables

public ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3 withVariables(Map<String,Object> variables)

Description copied from interface: ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3

Create a GatewayOuterClass.ModifyProcessInstanceRequest.VariableInstruction for the element that's getting activated. These variables will be created in the global scope of the process instance.

Specified by:

withVariables in interface ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3

Parameters:

variables - the variables JSON document as map

Returns:

the builder for this command

withVariables

public ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3 withVariables(Map<String,Object> variables,
 String scopeId)

Description copied from interface: ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3

Create a GatewayOuterClass.ModifyProcessInstanceRequest.VariableInstruction for the element that's getting activated. These variables will be created in the scope of the passed element.

Specified by:

withVariables in interface ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3

Parameters:

variables - the variables JSON document as map

scopeId - the id of the element in which scope the variables should be created

Returns:

the builder for this command

withVariables

public ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3 withVariables(Object variables)

Description copied from interface: ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3

Create a GatewayOuterClass.ModifyProcessInstanceRequest.VariableInstruction for the element that's getting activated. These variables will be created in the global scope of the process instance.

Specified by:

withVariables in interface ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3

Parameters:

variables - the variables document as object to be serialized to JSON

Returns:

the builder for this command

withVariables

public ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3 withVariables(Object variables,
 String scopeId)

Description copied from interface: ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3

Create a GatewayOuterClass.ModifyProcessInstanceRequest.VariableInstruction for the element that's getting activated. These variables will be created in the scope of the passed element.

Specified by:

withVariables in interface ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3

Parameters:

variables - the variables document as object to be serialized to JSON

scopeId - the id of the element in which scope the variables should be created

Returns:

the builder for this command

requestTimeout

public FinalCommandStep<ModifyProcessInstanceResponse> requestTimeout(Duration requestTimeout)

Description copied from interface: FinalCommandStep

Sets the request timeout for the command. The default request timeout can be configured using ZeebeClientBuilder.defaultRequestTimeout(Duration).

Specified by:

requestTimeout in interface FinalCommandStep<ModifyProcessInstanceResponse>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

public ZeebeFuture<ModifyProcessInstanceResponse> send()

Description copied from interface: FinalCommandStep

Sends the command to the Zeebe broker. This operation is asynchronous. In case of success, the future returns the event that was generated by the Zeebe broker in response to the command.

Call ZeebeFuture.join() to wait until the response is available.

 Future<JobEvent&#62 future = command.send();
 JobEvent event = future.join();
 

Specified by:

send in interface FinalCommandStep<ModifyProcessInstanceResponse>

Returns:

a future tracking state of success/failure of the command.