windmill_api/models/
flow_module.rs

1/*
2 * Windmill API
3 *
4 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5 *
6 * The version of the OpenAPI document: 1.824.1
7 * Contact: contact@windmill.dev
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14/// FlowModule : A single step in a flow. Can be a script, subflow, loop, or branch
15#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
16pub struct FlowModule {
17    /// Unique identifier for this step. Used to reference results via 'results.step_id'. Must be a valid identifier (alphanumeric, underscore, hyphen)
18    #[serde(rename = "id")]
19    pub id: String,
20    #[serde(rename = "value")]
21    pub value: Box<models::FlowModuleValue>,
22    #[serde(rename = "stop_after_if", skip_serializing_if = "Option::is_none")]
23    pub stop_after_if: Option<Box<models::StopAfterIf>>,
24    #[serde(rename = "stop_after_all_iters_if", skip_serializing_if = "Option::is_none")]
25    pub stop_after_all_iters_if: Option<Box<models::StopAfterIf>>,
26    #[serde(rename = "skip_if", skip_serializing_if = "Option::is_none")]
27    pub skip_if: Option<Box<models::FlowModuleSkipIf>>,
28    #[serde(rename = "sleep", skip_serializing_if = "Option::is_none")]
29    pub sleep: Option<Box<models::InputTransform>>,
30    /// Cache duration in seconds for this step's results
31    #[serde(rename = "cache_ttl", skip_serializing_if = "Option::is_none")]
32    pub cache_ttl: Option<f64>,
33    #[serde(rename = "cache_ignore_s3_path", skip_serializing_if = "Option::is_none")]
34    pub cache_ignore_s3_path: Option<bool>,
35    #[serde(rename = "timeout", skip_serializing_if = "Option::is_none")]
36    pub timeout: Option<Box<models::InputTransform>>,
37    /// If set, delete the step's args, result and logs after this many seconds following job completion
38    #[serde(rename = "delete_after_secs", skip_serializing_if = "Option::is_none")]
39    pub delete_after_secs: Option<i32>,
40    /// Short description of what this step does
41    #[serde(rename = "summary", skip_serializing_if = "Option::is_none")]
42    pub summary: Option<String>,
43    #[serde(rename = "mock", skip_serializing_if = "Option::is_none")]
44    pub mock: Option<Box<models::FlowModuleMock>>,
45    #[serde(rename = "suspend", skip_serializing_if = "Option::is_none")]
46    pub suspend: Option<Box<models::FlowModuleSuspend>>,
47    /// Execution priority for this step (higher numbers run first)
48    #[serde(rename = "priority", skip_serializing_if = "Option::is_none")]
49    pub priority: Option<f64>,
50    /// If true, flow continues even if this step fails
51    #[serde(rename = "continue_on_error", skip_serializing_if = "Option::is_none")]
52    pub continue_on_error: Option<bool>,
53    /// Scopes the token of this step's jobs is restricted to (domain:action[:resource], e.g. oidc:write), on top of the flow's own restriction: a step can only narrow it. Applies to everything the step runs (loop and branch bodies, AI agent tools).
54    #[serde(rename = "job_token_scopes", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
55    pub job_token_scopes: Option<Option<Vec<String>>>,
56    #[serde(rename = "retry", skip_serializing_if = "Option::is_none")]
57    pub retry: Option<Box<models::Retry>>,
58    #[serde(rename = "debouncing", skip_serializing_if = "Option::is_none")]
59    pub debouncing: Option<Box<models::FlowModuleDebouncing>>,
60}
61
62impl FlowModule {
63    /// A single step in a flow. Can be a script, subflow, loop, or branch
64    pub fn new(id: String, value: models::FlowModuleValue) -> FlowModule {
65        FlowModule {
66            id,
67            value: Box::new(value),
68            stop_after_if: None,
69            stop_after_all_iters_if: None,
70            skip_if: None,
71            sleep: None,
72            cache_ttl: None,
73            cache_ignore_s3_path: None,
74            timeout: None,
75            delete_after_secs: None,
76            summary: None,
77            mock: None,
78            suspend: None,
79            priority: None,
80            continue_on_error: None,
81            job_token_scopes: None,
82            retry: None,
83            debouncing: None,
84        }
85    }
86}
87
windmill_api/models/flow_module.rs

windmill_api/models/
flow_module.rs
