Struct Flow 

pub struct Flow {

    pub summary: String,
    pub description: Option<String>,
    pub value: Box<FlowValue>,
    pub schema: Option<Value>,
    pub on_behalf_of_email: Option<String>,
    pub on_behalf_of: Option<String>,
    pub workspace_id: Option<String>,
    pub path: String,
    pub edited_by: String,
    pub edited_at: String,
    pub archived: bool,
    pub extra_perms: HashMap<String, bool>,
    pub starred: Option<bool>,
    pub draft_only: Option<bool>,
    pub tag: Option<String>,
    pub ws_error_handler_muted: Option<bool>,
    pub priority: Option<i32>,
    pub dedicated_worker: Option<bool>,
    pub timeout: Option<f64>,
    pub visible_to_runner_only: Option<bool>,
    pub labels: Option<Vec<String>>,
    pub job_token_scopes: Option<Option<Vec<String>>>,
    pub inherited_labels: Option<Vec<String>>,
    pub lock_error_logs: Option<String>,
    pub version_id: Option<f64>,
}

Fields

summary: String

Short description of what this flow does

description: Option<String>

Detailed documentation for this flow

value: Box<FlowValue>

schema: Option<Value>

JSON Schema for flow inputs. Use this to define input parameters, their types, defaults, and validation. For resource inputs, set type to ‘object’ and format to ‘resource-’ (e.g., ‘resource-stripe’)

on_behalf_of_email: Option<String>

on_behalf_of: Option<String>

Authorization identity the runnable runs as: u/{username}, g/{group}, or a bare email when the username is itself email-shaped. The only stored half of the identity; on_behalf_of_email is derived from it.

workspace_id: Option<String>

path: String

edited_by: String

edited_at: String

archived: bool

extra_perms: HashMap<String, bool>

starred: Option<bool>

draft_only: Option<bool>

tag: Option<String>

ws_error_handler_muted: Option<bool>

priority: Option<i32>

dedicated_worker: Option<bool>

timeout: Option<f64>

visible_to_runner_only: Option<bool>

labels: Option<Vec<String>>

job_token_scopes: Option<Option<Vec<String>>>

Scopes the token of every job of this runnable is restricted to (domain:action[:resource], e.g. oidc:write). Jobs it starts, flow steps and AI agent tools inherit the restriction. Unset, the job token carries the full permissions of the identity the job runs as; an empty list leaves it no API access beyond its own job.

inherited_labels: Option<Vec<String>>

Labels inherited from the parent folder, computed at read time. Read-only — edit them on the folder.

lock_error_logs: Option<String>

version_id: Option<f64>

Implementations

impl Flow

pub fn new( summary: String, value: FlowValue, path: String, edited_by: String, edited_at: String, archived: bool, extra_perms: HashMap<String, bool>, ) -> Flow

Trait Implementations

impl Clone for Flow

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Flow

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

Formats the value using the given formatter.

impl Default for Flow

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Flow

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Flow

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Flow

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Flow