pub struct SetVariablesBuilder { /* private fields */ }
Expand description
Updates all the variables of a particular scope (e.g. process instance, flow element instance) from the given JSON document.
Implementations§
Source§impl SetVariablesBuilder
impl SetVariablesBuilder
Sourcepub fn with_element_instance_key(self, element_instance_key: i64) -> Self
pub fn with_element_instance_key(self, element_instance_key: i64) -> Self
Set the unique identifier of this element.
can be the process instance key (as obtained during instance creation), or
a given element, such as a service task (see element_instance_key
on the job
message).
Sourcepub fn with_variables<T: Into<Value>>(self, variables: T) -> Self
pub fn with_variables<T: Into<Value>>(self, variables: T) -> Self
Set variables for this element.
Variables are a JSON serialized document describing variables as key value pairs; the root of the document must be a JSON object.
Sourcepub fn with_local(self, local: bool) -> Self
pub fn with_local(self, local: bool) -> Self
Set local scope for this request.
If set to true
, the variables will be merged strictly into the local scope
(as indicated by element_instance_key); this means the variables are not
propagated to upper scopes.
§Example
Two scopes:
- 1 =>
{ "foo" : 2 }
- 2 =>
{ "bar" : 1 }
If we send an update request with element_instance_key
= 2
, variables
{ "foo" : 5 }
, and local
is true
, then the result is:
- 1 =>
{ "foo" : 2 }
- 2 =>
{ "bar" : 1, "foo" 5 }
If local
was false
, however, then the result is:
- 1 =>
{ "foo": 5 }
, - 2 =>
{ "bar" : 1 }
Sourcepub async fn send(self) -> Result<SetVariablesResponse>
pub async fn send(self) -> Result<SetVariablesResponse>
Submit this set variables request to the configured Zeebe brokers.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for SetVariablesBuilder
impl !RefUnwindSafe for SetVariablesBuilder
impl !Send for SetVariablesBuilder
impl !Sync for SetVariablesBuilder
impl Unpin for SetVariablesBuilder
impl !UnwindSafe for SetVariablesBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T
in a tonic::Request