Struct AssignmentMutation

pub struct AssignmentMutation {
    pub conditions: Option<Vec<BlockStartMessageConditionsInner>>,
    pub type: Type,
    pub variable: String,
    pub value: String,
}

Fields

conditions: Option<Vec<BlockStartMessageConditionsInner>>

This is an optional array of conditions that must be met for this mutation to be triggered.

type: Type

This mutation assigns a new value to an existing or new variable.

variable: String

This is the variable to assign a new value to. You can reference any variable in the context of the current block execution (step): - "output.your-property-name" for current step’s output - "your-step-name.output.your-property-name" for another step’s output (in the same workflow; read caveat #1) - "your-block-name.output.your-property-name" for another block’s output (in the same workflow; read caveat #2) - "global.your-property-name" for the global context This needs to be the key path of the variable. If you use {{}}, it’ll dereference that to the value of the variable before assignment. This can be useful if the path is dynamic. Example: - "global.{{my-tool-call-step.output.my-key-name}}" You can also string interpolate multiple variables to get the key name: - "global.{{my-tool-call-step.output.my-key-name-suffix}}-{{my-tool-call-step.output.my-key-name}}" The path to the new variable is created if it doesn’t exist. Example: - "global.this-does-not-exist.neither-does-this" will create this-does-not-exist object with neither-does-this as a key Caveats: 1. a workflow can execute a step multiple times. example, if a loop is used in the graph. {{stepName.output.propertyName}} will reference the latest usage of the step. 2. a workflow can execute a block multiple times. example, if a step is called multiple times or if a block is used in multiple steps. {{blockName.output.propertyName}} will reference the latest usage of the block. this liquid variable is just provided for convenience when creating blocks outside of a workflow.

value: String

The value to assign to the variable. You can reference any variable in the context of the current block execution (step): - "{{output.your-property-name}}" for current step’s output - "{{your-step-name.output.your-property-name}}" for another step’s output (in the same workflow; read caveat #1) - "{{your-block-name.output.your-property-name}}" for another block’s output (in the same workflow; read caveat #2) - "{{global.your-property-name}}" for the global context Or, you can use a constant: - "1" - "text" - "true" - "false" Or, you can mix and match with string interpolation: - "{{your-property-name}}-{{input.your-property-name-2}}-1" Caveats: 1. a workflow can execute a step multiple times. example, if a loop is used in the graph. {{stepName.output.propertyName}} will reference the latest usage of the step. 2. a workflow can execute a block multiple times. example, if a step is called multiple times or if a block is used in multiple steps. {{blockName.output.propertyName}} will reference the latest usage of the block. this liquid variable is just provided for convenience when creating blocks outside of a workflow.

Implementations

impl AssignmentMutation

pub fn new(type: Type, variable: String, value: String) -> AssignmentMutation

Trait Implementations

impl Clone for AssignmentMutation

fn clone(&self) -> AssignmentMutation

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ComposeSchema for AssignmentMutation

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for AssignmentMutation

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

Formats the value using the given formatter.

impl Default for AssignmentMutation

fn default() -> AssignmentMutation

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AssignmentMutation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AssignmentMutation

fn eq(&self, other: &AssignmentMutation) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for AssignmentMutation

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSchema for AssignmentMutation

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.

impl StructuralPartialEq for AssignmentMutation