windmill_api/models/
new_script.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.794.0
7 * Contact: contact@windmill.dev
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
15pub struct NewScript {
16    #[serde(rename = "path")]
17    pub path: String,
18    /// The hash of the version this one supersedes: deploying with it archives that version and chains the new one onto its history, and a `path` differing from the superseded version's moves the script there.
19    #[serde(rename = "parent_hash", skip_serializing_if = "Option::is_none")]
20    pub parent_hash: Option<String>,
21    /// When true, the backend resolves the parent to the current deployed head for this path within the transaction (ignoring parent_hash), instead of failing with a \"lineage must be linear\" error when the supplied parent_hash is stale.
22    #[serde(rename = "auto_parent", skip_serializing_if = "Option::is_none")]
23    pub auto_parent: Option<bool>,
24    #[serde(rename = "summary")]
25    pub summary: String,
26    #[serde(rename = "description", skip_serializing_if = "Option::is_none")]
27    pub description: Option<String>,
28    #[serde(rename = "content")]
29    pub content: String,
30    #[serde(rename = "schema", skip_serializing_if = "Option::is_none")]
31    pub schema: Option<serde_json::Value>,
32    #[serde(rename = "is_template", skip_serializing_if = "Option::is_none")]
33    pub is_template: Option<bool>,
34    #[serde(rename = "lock", skip_serializing_if = "Option::is_none")]
35    pub lock: Option<String>,
36    #[serde(rename = "language")]
37    pub language: models::ScriptLang,
38    #[serde(rename = "kind", skip_serializing_if = "Option::is_none")]
39    pub kind: Option<Kind>,
40    #[serde(rename = "tag", skip_serializing_if = "Option::is_none")]
41    pub tag: Option<String>,
42    #[serde(rename = "envs", skip_serializing_if = "Option::is_none")]
43    pub envs: Option<Vec<String>>,
44    #[serde(rename = "concurrent_limit", skip_serializing_if = "Option::is_none")]
45    pub concurrent_limit: Option<i32>,
46    #[serde(rename = "concurrency_time_window_s", skip_serializing_if = "Option::is_none")]
47    pub concurrency_time_window_s: Option<i32>,
48    #[serde(rename = "cache_ttl", skip_serializing_if = "Option::is_none")]
49    pub cache_ttl: Option<f64>,
50    #[serde(rename = "cache_ignore_s3_path", skip_serializing_if = "Option::is_none")]
51    pub cache_ignore_s3_path: Option<bool>,
52    #[serde(rename = "dedicated_worker", skip_serializing_if = "Option::is_none")]
53    pub dedicated_worker: Option<bool>,
54    #[serde(rename = "ws_error_handler_muted", skip_serializing_if = "Option::is_none")]
55    pub ws_error_handler_muted: Option<bool>,
56    #[serde(rename = "priority", skip_serializing_if = "Option::is_none")]
57    pub priority: Option<i32>,
58    #[serde(rename = "restart_unless_cancelled", skip_serializing_if = "Option::is_none")]
59    pub restart_unless_cancelled: Option<bool>,
60    #[serde(rename = "timeout", skip_serializing_if = "Option::is_none")]
61    pub timeout: Option<i32>,
62    /// If set, delete the job's args, result and logs after this many seconds following job completion
63    #[serde(rename = "delete_after_secs", skip_serializing_if = "Option::is_none")]
64    pub delete_after_secs: Option<i32>,
65    #[serde(rename = "deployment_message", skip_serializing_if = "Option::is_none")]
66    pub deployment_message: Option<String>,
67    #[serde(rename = "concurrency_key", skip_serializing_if = "Option::is_none")]
68    pub concurrency_key: Option<String>,
69    #[serde(rename = "debounce_key", skip_serializing_if = "Option::is_none")]
70    pub debounce_key: Option<String>,
71    #[serde(rename = "debounce_delay_s", skip_serializing_if = "Option::is_none")]
72    pub debounce_delay_s: Option<i32>,
73    #[serde(rename = "debounce_args_to_accumulate", skip_serializing_if = "Option::is_none")]
74    pub debounce_args_to_accumulate: Option<Vec<String>>,
75    #[serde(rename = "max_total_debouncing_time", skip_serializing_if = "Option::is_none")]
76    pub max_total_debouncing_time: Option<i32>,
77    #[serde(rename = "max_total_debounces_amount", skip_serializing_if = "Option::is_none")]
78    pub max_total_debounces_amount: Option<i32>,
79    #[serde(rename = "visible_to_runner_only", skip_serializing_if = "Option::is_none")]
80    pub visible_to_runner_only: Option<bool>,
81    #[serde(rename = "auto_kind", skip_serializing_if = "Option::is_none")]
82    pub auto_kind: Option<String>,
83    #[serde(rename = "codebase", skip_serializing_if = "Option::is_none")]
84    pub codebase: Option<String>,
85    #[serde(rename = "has_preprocessor", skip_serializing_if = "Option::is_none")]
86    pub has_preprocessor: Option<bool>,
87    #[serde(rename = "on_behalf_of_email", skip_serializing_if = "Option::is_none")]
88    pub on_behalf_of_email: Option<String>,
89    /// Authorization identity to run as: u/{username}, g/{group}, or a bare email when the username is itself email-shaped. Supply this or on_behalf_of_email; when only the address is given it is resolved to the account it names, and an address naming nobody is rejected. A pair that disagrees is rejected.
90    #[serde(rename = "on_behalf_of", skip_serializing_if = "Option::is_none")]
91    pub on_behalf_of: Option<String>,
92    /// When true and the caller is a member of the 'wm_deployers' group, preserves the original on_behalf_of_email / on_behalf_of pair instead of overwriting it with the caller's own identity.
93    #[serde(rename = "preserve_on_behalf_of", skip_serializing_if = "Option::is_none")]
94    pub preserve_on_behalf_of: Option<bool>,
95    #[serde(rename = "assets", skip_serializing_if = "Option::is_none")]
96    pub assets: Option<Vec<models::NewScriptAssetsInner>>,
97    /// Additional script modules keyed by relative file path
98    #[serde(rename = "modules", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
99    pub modules: Option<Option<std::collections::HashMap<String, models::ScriptModule>>>,
100    #[serde(rename = "labels", skip_serializing_if = "Option::is_none")]
101    pub labels: Option<Vec<String>>,
102    /// When true (set by the CLI / git sync), deploying this script does not delete an existing user draft at the same path.
103    #[serde(rename = "skip_draft_deletion", skip_serializing_if = "Option::is_none")]
104    pub skip_draft_deletion: Option<bool>,
105}
106
107impl NewScript {
108    pub fn new(path: String, summary: String, content: String, language: models::ScriptLang) -> NewScript {
109        NewScript {
110            path,
111            parent_hash: None,
112            auto_parent: None,
113            summary,
114            description: None,
115            content,
116            schema: None,
117            is_template: None,
118            lock: None,
119            language,
120            kind: None,
121            tag: None,
122            envs: None,
123            concurrent_limit: None,
124            concurrency_time_window_s: None,
125            cache_ttl: None,
126            cache_ignore_s3_path: None,
127            dedicated_worker: None,
128            ws_error_handler_muted: None,
129            priority: None,
130            restart_unless_cancelled: None,
131            timeout: None,
132            delete_after_secs: None,
133            deployment_message: None,
134            concurrency_key: None,
135            debounce_key: None,
136            debounce_delay_s: None,
137            debounce_args_to_accumulate: None,
138            max_total_debouncing_time: None,
139            max_total_debounces_amount: None,
140            visible_to_runner_only: None,
141            auto_kind: None,
142            codebase: None,
143            has_preprocessor: None,
144            on_behalf_of_email: None,
145            on_behalf_of: None,
146            preserve_on_behalf_of: None,
147            assets: None,
148            modules: None,
149            labels: None,
150            skip_draft_deletion: None,
151        }
152    }
153}
154/// 
155#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
156pub enum Kind {
157    #[serde(rename = "script")]
158    Script,
159    #[serde(rename = "failure")]
160    Failure,
161    #[serde(rename = "trigger")]
162    Trigger,
163    #[serde(rename = "command")]
164    Command,
165    #[serde(rename = "approval")]
166    Approval,
167    #[serde(rename = "preprocessor")]
168    Preprocessor,
169}
170
171impl Default for Kind {
172    fn default() -> Kind {
173        Self::Script
174    }
175}
176
windmill_api/models/new_script.rs

windmill_api/models/
new_script.rs
