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
ConstructorDescriptionModifyProcessInstanceCommandImpl
(long processInstanceKey, JsonMapper jsonMapper, GatewayGrpc.GatewayStub asyncStub, Duration requestTimeout, Predicate<Throwable> retryPredicate) -
Method Summary
Modifier and TypeMethodDescriptionactivateElement
(String elementId) Create anGatewayOuterClass.ModifyProcessInstanceRequest.ActivateInstruction
for the given element id.activateElement
(String elementId, long ancestorElementInstanceKey) Create anGatewayOuterClass.ModifyProcessInstanceRequest.ActivateInstruction
for the given element id.and()
Acts as a boundary between the different activate and terminate instructions.requestTimeout
(Duration requestTimeout) Sets the request timeout for the command.send()
Sends the command to the Zeebe broker.terminateElement
(long elementInstanceKey) Create aGatewayOuterClass.ModifyProcessInstanceRequest.TerminateInstruction
for the given element id.withVariables
(InputStream variables) Create aGatewayOuterClass.ModifyProcessInstanceRequest.VariableInstruction
for the element that's getting activated.withVariables
(InputStream variables, String scopeId) Create aGatewayOuterClass.ModifyProcessInstanceRequest.VariableInstruction
for the element that's getting activated.withVariables
(Object variables) Create aGatewayOuterClass.ModifyProcessInstanceRequest.VariableInstruction
for the element that's getting activated.withVariables
(Object variables, String scopeId) Create aGatewayOuterClass.ModifyProcessInstanceRequest.VariableInstruction
for the element that's getting activated.withVariables
(String variables) Create aGatewayOuterClass.ModifyProcessInstanceRequest.VariableInstruction
for the element that's getting activated.withVariables
(String variables, String scopeId) Create aGatewayOuterClass.ModifyProcessInstanceRequest.VariableInstruction
for the element that's getting activated.withVariables
(Map<String, Object> variables) Create aGatewayOuterClass.ModifyProcessInstanceRequest.VariableInstruction
for the element that's getting activated.withVariables
(Map<String, Object> variables, String scopeId) Create aGatewayOuterClass.ModifyProcessInstanceRequest.VariableInstruction
for the element that's getting activated.
-
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 anGatewayOuterClass.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 useModifyProcessInstanceCommandStep1.activateElement(String, long)
.- Specified by:
activateElement
in interfaceModifyProcessInstanceCommandStep1
- 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 anGatewayOuterClass.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 interfaceModifyProcessInstanceCommandStep1
- Parameters:
elementId
- the id of the element to activateancestorElementInstanceKey
- 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 aGatewayOuterClass.ModifyProcessInstanceRequest.TerminateInstruction
for the given element id.- Specified by:
terminateElement
in interfaceModifyProcessInstanceCommandStep1
- Parameters:
elementInstanceKey
- the element instance key of the element to termiante- Returns:
- the builder for this command
-
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 interfaceModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep2
- Returns:
- the builder for this command
-
withVariables
public ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3 withVariables(InputStream variables) Description copied from interface:ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3
Create aGatewayOuterClass.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 interfaceModifyProcessInstanceCommandStep1.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 aGatewayOuterClass.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 interfaceModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3
- Parameters:
variables
- the variables JSON document as streamscopeId
- 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 aGatewayOuterClass.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 interfaceModifyProcessInstanceCommandStep1.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 aGatewayOuterClass.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 interfaceModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3
- Parameters:
variables
- the variables JSON document as StringscopeId
- 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 aGatewayOuterClass.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 interfaceModifyProcessInstanceCommandStep1.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 aGatewayOuterClass.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 interfaceModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3
- Parameters:
variables
- the variables JSON document as mapscopeId
- 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 aGatewayOuterClass.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 interfaceModifyProcessInstanceCommandStep1.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 aGatewayOuterClass.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 interfaceModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3
- Parameters:
variables
- the variables document as object to be serialized to JSONscopeId
- the id of the element in which scope the variables should be created- Returns:
- the builder for this command
-
requestTimeout
Description copied from interface:FinalCommandStep
Sets the request timeout for the command. The default request timeout can be configured usingZeebeClientBuilder.defaultRequestTimeout(Duration)
.- Specified by:
requestTimeout
in interfaceFinalCommandStep<ModifyProcessInstanceResponse>
- Parameters:
requestTimeout
- the request timeout- Returns:
- the configured command
-
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> future = command.send(); JobEvent event = future.join();
- Specified by:
send
in interfaceFinalCommandStep<ModifyProcessInstanceResponse>
- Returns:
- a future tracking state of success/failure of the command.
-