Package io.camunda.client.impl.command

Class SetVariablesCommandImpl

java.lang.Object

io.camunda.client.impl.command.CommandWithVariables<SetVariablesCommandStep1.SetVariablesCommandStep2>

io.camunda.client.impl.command.SetVariablesCommandImpl

All Implemented Interfaces:

CommandWithCommunicationApiStep<SetVariablesCommandStep1>, CommandWithOperationReferenceStep<SetVariablesCommandStep1.SetVariablesCommandStep2>, CommandWithVariables<SetVariablesCommandStep1.SetVariablesCommandStep2>, FinalCommandStep<SetVariablesResponse>, SetVariablesCommandStep1, SetVariablesCommandStep1.SetVariablesCommandStep2

public final class SetVariablesCommandImpl
extends CommandWithVariables<SetVariablesCommandStep1.SetVariablesCommandStep2>
implements SetVariablesCommandStep1, SetVariablesCommandStep1.SetVariablesCommandStep2

Nested Class Summary

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

SetVariablesCommandStep1.SetVariablesCommandStep2

Field Summary

Fields inherited from class io.camunda.client.impl.command.CommandWithVariables

objectMapper

Constructor Summary

Constructors

Constructor	Description
SetVariablesCommandImpl(GatewayGrpc.GatewayStub asyncStub, JsonMapper jsonMapper, long elementInstanceKey, Duration requestTimeout, Predicate<CredentialsProvider.StatusCode> retryPredicate, HttpClient httpClient, boolean preferRestOverGrpc)

Method Summary

Modifier and Type	Method	Description
SetVariablesCommandStep1.SetVariablesCommandStep2	local(boolean local)	If true, the variables will be merged strictly into the local scope (as indicated by elementInstanceKey); this means the variables is not propagated to upper scopes.
SetVariablesCommandStep1.SetVariablesCommandStep2	operationReference(long operationReference)	Set the Operation Reference.
FinalCommandStep<SetVariablesResponse>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
CamundaFuture<SetVariablesResponse>	send()	Sends the command to the Camunda gateway.
SetVariablesCommandStep1.SetVariablesCommandStep2	setVariablesInternal(String variables)
SetVariablesCommandStep1	useGrpc()	Experimental: This method is under development, and as such using it may have no effect on the command builder when called.
SetVariablesCommandStep1	useRest()	Experimental: This method is under development, and as such using it may have no effect on the command builder when called.

Methods inherited from class io.camunda.client.impl.command.CommandWithVariables

variable, variables, variables, variables, variables

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.camunda.client.api.command.SetVariablesCommandStep1

variable, variables, variables, variables, variables

Constructor Details

SetVariablesCommandImpl

public SetVariablesCommandImpl(GatewayGrpc.GatewayStub asyncStub,
 JsonMapper jsonMapper,
 long elementInstanceKey,
 Duration requestTimeout,
 Predicate<CredentialsProvider.StatusCode> retryPredicate,
 HttpClient httpClient,
 boolean preferRestOverGrpc)

Method Details

requestTimeout

public FinalCommandStep<SetVariablesResponse> requestTimeout(Duration requestTimeout)

Description copied from interface: FinalCommandStep

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

Specified by:

requestTimeout in interface FinalCommandStep<SetVariablesResponse>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

public CamundaFuture<SetVariablesResponse> send()

Description copied from interface: FinalCommandStep

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

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

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

Specified by:

send in interface FinalCommandStep<SetVariablesResponse>

Returns:

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

local

public SetVariablesCommandStep1.SetVariablesCommandStep2 local(boolean local)

Description copied from interface: SetVariablesCommandStep1.SetVariablesCommandStep2

If true, the variables will be merged strictly into the local scope (as indicated by elementInstanceKey); this means the variables is not propagated to upper scopes.

For example, let's say we have two scopes, '1' and '2', with each having effective variables as:

1. 1 => `{ "foo" : 2 }`
2. 2 => `{ "bar" : 1 }`

If we send an update request with elementInstanceKey = 2, a new document of `{ "foo" : 5 }`, and local is true, then scope 1 will be unchanged, and scope 2 will now be `{ "bar" : 1, "foo" 5 }`.

If local was false, however, then scope 1 would be `{ "foo": 5 }`, and scope 2 would be `{ "bar" : 1 }`.

Specified by:

local in interface SetVariablesCommandStep1.SetVariablesCommandStep2

Parameters:

local - whether or not to update only the local scope

Returns:

the builder for this command. Call FinalCommandStep.send() to complete the command and send it to the broker.

setVariablesInternal

public SetVariablesCommandStep1.SetVariablesCommandStep2 setVariablesInternal(String variables)

Specified by:

setVariablesInternal in class CommandWithVariables<SetVariablesCommandStep1.SetVariablesCommandStep2>

operationReference

public SetVariablesCommandStep1.SetVariablesCommandStep2 operationReference(long operationReference)

Description copied from interface: CommandWithOperationReferenceStep

Set the Operation Reference.

This is a key chosen by the user and will be part of all records resulted from this operation

Specified by:

operationReference in interface CommandWithOperationReferenceStep<SetVariablesCommandStep1.SetVariablesCommandStep2>

Parameters:

operationReference - a reference key chosen by the user and will be part of all records resulted from this operation

Returns:

the builder for this command with the operation reference specified

useRest

public SetVariablesCommandStep1 useRest()

Description copied from interface: CommandWithCommunicationApiStep

Experimental: This method is under development, and as such using it may have no effect on the command builder when called. While unimplemented, it simply returns the command builder instance unchanged. This method already exists for software that is building support for a REST API in Camunda, and already wants to use this API during its development. As support for REST is added to Camunda, each of the commands that implement this method may start to take effect. Until this warning is removed, anything described below may not yet have taken effect, and the interface and its description are subject to change.

Sets REST as the communication API for this command. If this command doesn't support communication over REST, it simply returns the command builder instance unchanged. The default communication API can be configured using CamundaClientBuilder.preferRestOverGrpc(boolean).

Specified by:

useRest in interface CommandWithCommunicationApiStep<SetVariablesCommandStep1>

Returns:

the configured command

useGrpc

public SetVariablesCommandStep1 useGrpc()

Description copied from interface: CommandWithCommunicationApiStep

Experimental: This method is under development, and as such using it may have no effect on the command builder when called. While unimplemented, it simply returns the command builder instance unchanged. This method already exists for software that is building support for a REST API in Camunda, and already wants to use this API during its development. As support for REST is added to Zeebe, each of the commands that implement this method may start to take effect. Until this warning is removed, anything described below may not yet have taken effect, and the interface and its description are subject to change.

Sets gRPC as the communication API for this command. If this command doesn't support communication over gRPC, it simply returns the command builder instance unchanged. The default communication API can be configured using CamundaClientBuilder.preferRestOverGrpc(boolean).

Specified by:

useGrpc in interface CommandWithCommunicationApiStep<SetVariablesCommandStep1>

Returns:

the configured command