Package io.zeebe.client.api.command
Interface SetVariablesCommandStep1.SetVariablesCommandStep2
-
- All Superinterfaces:
FinalCommandStep<SetVariablesResponse>
- All Known Implementing Classes:
SetVariablesCommandImpl
- Enclosing interface:
- SetVariablesCommandStep1
public static interface SetVariablesCommandStep1.SetVariablesCommandStep2 extends FinalCommandStep<SetVariablesResponse>
-
-
Method Summary
All Methods Instance Methods Abstract Methods 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.-
Methods inherited from interface io.zeebe.client.api.command.FinalCommandStep
requestTimeout, send
-
-
-
-
Method Detail
-
local
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.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 }`.
- 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.
-
-