Skip to main content

FlowValue

Struct FlowValue 

Source
pub struct FlowValue {
Show 25 fields pub modules: Vec<FlowModule>, pub failure_module: Option<Box<FlowModule>>, pub preprocessor_module: Option<Box<FlowModule>>, pub same_worker: Option<bool>, pub preserve_step_tags: Option<bool>, pub concurrent_limit: Option<f64>, pub concurrency_key: Option<String>, pub concurrency_time_window_s: Option<f64>, pub on_concurrency_limit: Option<OnConcurrencyLimit>, pub debounce_delay_s: Option<i32>, pub debounce_key: Option<String>, pub debounce_args_to_accumulate: Option<Vec<String>>, pub max_total_debouncing_time: Option<i32>, pub max_total_debounces_amount: Option<i32>, pub skip_expr: Option<String>, pub cache_ttl: Option<f64>, pub cache_ignore_s3_path: Option<bool>, pub delete_after_secs: Option<i32>, pub timeout: Option<i32>, pub flow_env: Option<HashMap<String, Value>>, pub priority: Option<f64>, pub early_return: Option<String>, pub chat_input_enabled: Option<bool>, pub notes: Option<Vec<FlowNote>>, pub groups: Option<Vec<FlowGroup>>,
}
Expand description

FlowValue : The flow structure containing modules and optional preprocessor/failure handlers

Fields§

§modules: Vec<FlowModule>

Array of steps that execute in sequence. Each step can be a script, subflow, loop, or branch

§failure_module: Option<Box<FlowModule>>§preprocessor_module: Option<Box<FlowModule>>§same_worker: Option<bool>

If true, all steps run on the same worker for better performance

§preserve_step_tags: Option<bool>

If true and the flow runs on a custom worker tag, steps that declare their own non-empty tag run on it instead of inheriting the flow tag. Steps without their own tag still inherit the flow tag.

§concurrent_limit: Option<f64>

Maximum number of concurrent executions of this flow

§concurrency_key: Option<String>

Expression to group concurrent executions (e.g., by user ID)

§concurrency_time_window_s: Option<f64>

Time window in seconds for concurrent_limit

§on_concurrency_limit: Option<OnConcurrencyLimit>

What a run of this flow does when its concurrency limit is reached. queue (default) re-queues it to a later slot, fail ends it immediately as failed, like any failed step.

§debounce_delay_s: Option<i32>

Delay in seconds to debounce flow executions

§debounce_key: Option<String>

Expression to group debounced executions

§debounce_args_to_accumulate: Option<Vec<String>>

Arguments to accumulate across debounced executions

§max_total_debouncing_time: Option<i32>

Maximum total time in seconds that a job can be debounced

§max_total_debounces_amount: Option<i32>

Maximum number of times a job can be debounced

§skip_expr: Option<String>

JavaScript expression to conditionally skip the entire flow

§cache_ttl: Option<f64>

Cache duration in seconds for flow results

§cache_ignore_s3_path: Option<bool>§delete_after_secs: Option<i32>

If set, delete the flow job’s args, result and logs after this many seconds following job completion

§timeout: Option<i32>

Wall-clock limit in seconds for the whole flow run, counted from its start and including time spent sleeping or suspended at an approval. It also applies when the flow is called as a subflow step, unless that step sets its own timeout, which replaces it. It is checked periodically, so a run can go a few seconds past it. When it expires, the running steps are cancelled, the failure module runs if there is one, and the flow ends cancelled with a timeout error. A calling flow sees the subflow step fail with that error.

§flow_env: Option<HashMap<String, Value>>

Environment variables available to all steps. Values can be strings, JSON values, or special references: ‘$var:path’ (workspace variable) or ‘$res:path’ (resource).

§priority: Option<f64>

Execution priority (higher numbers run first)

§early_return: Option<String>

Id of the step whose result a sync webhook returns as soon as that step completes, while the rest of the flow keeps running. When the step does not run, or fails while the flow has a failure module, the flow’s final result is returned instead.

§chat_input_enabled: Option<bool>

Whether this flow accepts chat-style input

§notes: Option<Vec<FlowNote>>

Sticky notes attached to the flow

§groups: Option<Vec<FlowGroup>>

Semantic groups of modules for organizational purposes

Implementations§

Source§

impl FlowValue

Source

pub fn new(modules: Vec<FlowModule>) -> FlowValue

The flow structure containing modules and optional preprocessor/failure handlers

Trait Implementations§

Source§

impl Clone for FlowValue

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FlowValue

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for FlowValue

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for FlowValue

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for FlowValue

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for FlowValue

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for FlowValue

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more