Struct SetVariablesBuilder

pub struct SetVariablesBuilder { /* private fields */ }

Updates all the variables of a particular scope (e.g. process instance, flow element instance) from the given JSON document.

Implementations

impl SetVariablesBuilder

pub fn new(client: Client) -> Self

Create a new set variables builder

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).

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.

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 }

pub async fn send(self) -> Result<SetVariablesResponse>

Submit this set variables request to the configured Zeebe brokers.

Trait Implementations

impl Debug for SetVariablesBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.