Zeebe.Client.Api.Commands.ISetVariablesCommandStep2 Interface Reference

Inheritance diagram for Zeebe.Client.Api.Commands.ISetVariablesCommandStep2:

Public Member Functions
ISetVariablesCommandStep2	Local ()
	The variables will be merged strictly into the local scope (as indicated by the given elementInstanceKey); this means the variables is not propagated to upper scopes.
Public Member Functions inherited from Zeebe.Client.Api.Commands.IFinalCommandWithRetryStep< ISetVariablesResponse >
Task< T >	SendWithRetry (TimeSpan? timeout=null, CancellationToken token=default)
	Sends the command with retry to the Zeebe broker. This operation is asynchronous. In case of success, the task returns the event that was generated by the Zeebe broker in response to the command. If the sending of the command fails, because of broker back pressure or network issues the request is retried until the command succeeds. The wait time between retries can be configured on the ZeebeClientBuilder. Per default the wait time is based on power two, which means 2^1 seconds, 2^2 seconds etc. until it reaches the maximum of one minute.

Member Function Documentation

Local()

ISetVariablesCommandStep2 Zeebe.Client.Api.Commands.ISetVariablesCommandStep2.Local

(

)

The variables will be merged strictly into the local scope (as indicated by the given 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 => { "foo" : 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 }.

Returns

the builder for this command. Call IFinalCommandStep<T>.Send to complete the command and send it to the broker.

---

The documentation for this interface was generated from the following file:

• Client/Api/Commands/ISetVariablesCommandStep1.cs