Skip to main content

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.739.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    #[serde(rename = "parent_hash", skip_serializing_if = "Option::is_none")]
19    pub parent_hash: Option<String>,
20    /// 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.
21    #[serde(rename = "auto_parent", skip_serializing_if = "Option::is_none")]
22    pub auto_parent: Option<bool>,
23    #[serde(rename = "summary")]
24    pub summary: String,
25    #[serde(rename = "description", skip_serializing_if = "Option::is_none")]
26    pub description: Option<String>,
27    #[serde(rename = "content")]
28    pub content: String,
29    #[serde(rename = "schema", skip_serializing_if = "Option::is_none")]
30    pub schema: Option<serde_json::Value>,
31    #[serde(rename = "is_template", skip_serializing_if = "Option::is_none")]
32    pub is_template: Option<bool>,
33    #[serde(rename = "lock", skip_serializing_if = "Option::is_none")]
34    pub lock: Option<String>,
35    #[serde(rename = "language")]
36    pub language: models::ScriptLang,
37    #[serde(rename = "kind", skip_serializing_if = "Option::is_none")]
38    pub kind: Option<Kind>,
39    #[serde(rename = "tag", skip_serializing_if = "Option::is_none")]
40    pub tag: Option<String>,
41    #[serde(rename = "envs", skip_serializing_if = "Option::is_none")]
42    pub envs: Option<Vec<String>>,
43    #[serde(rename = "concurrent_limit", skip_serializing_if = "Option::is_none")]
44    pub concurrent_limit: Option<i32>,
45    #[serde(rename = "concurrency_time_window_s", skip_serializing_if = "Option::is_none")]
46    pub concurrency_time_window_s: Option<i32>,
47    #[serde(rename = "cache_ttl", skip_serializing_if = "Option::is_none")]
48    pub cache_ttl: Option<f64>,
49    #[serde(rename = "cache_ignore_s3_path", skip_serializing_if = "Option::is_none")]
50    pub cache_ignore_s3_path: Option<bool>,
51    #[serde(rename = "dedicated_worker", skip_serializing_if = "Option::is_none")]
52    pub dedicated_worker: Option<bool>,
53    #[serde(rename = "ws_error_handler_muted", skip_serializing_if = "Option::is_none")]
54    pub ws_error_handler_muted: Option<bool>,
55    #[serde(rename = "priority", skip_serializing_if = "Option::is_none")]
56    pub priority: Option<i32>,
57    #[serde(rename = "restart_unless_cancelled", skip_serializing_if = "Option::is_none")]
58    pub restart_unless_cancelled: Option<bool>,
59    #[serde(rename = "timeout", skip_serializing_if = "Option::is_none")]
60    pub timeout: Option<i32>,
61    /// If set, delete the job's args, result and logs after this many seconds following job completion
62    #[serde(rename = "delete_after_secs", skip_serializing_if = "Option::is_none")]
63    pub delete_after_secs: Option<i32>,
64    #[serde(rename = "deployment_message", skip_serializing_if = "Option::is_none")]
65    pub deployment_message: Option<String>,
66    #[serde(rename = "concurrency_key", skip_serializing_if = "Option::is_none")]
67    pub concurrency_key: Option<String>,
68    #[serde(rename = "debounce_key", skip_serializing_if = "Option::is_none")]
69    pub debounce_key: Option<String>,
70    #[serde(rename = "debounce_delay_s", skip_serializing_if = "Option::is_none")]
71    pub debounce_delay_s: Option<i32>,
72    #[serde(rename = "debounce_args_to_accumulate", skip_serializing_if = "Option::is_none")]
73    pub debounce_args_to_accumulate: Option<Vec<String>>,
74    #[serde(rename = "max_total_debouncing_time", skip_serializing_if = "Option::is_none")]
75    pub max_total_debouncing_time: Option<i32>,
76    #[serde(rename = "max_total_debounces_amount", skip_serializing_if = "Option::is_none")]
77    pub max_total_debounces_amount: Option<i32>,
78    #[serde(rename = "visible_to_runner_only", skip_serializing_if = "Option::is_none")]
79    pub visible_to_runner_only: Option<bool>,
80    #[serde(rename = "auto_kind", skip_serializing_if = "Option::is_none")]
81    pub auto_kind: Option<String>,
82    #[serde(rename = "codebase", skip_serializing_if = "Option::is_none")]
83    pub codebase: Option<String>,
84    #[serde(rename = "has_preprocessor", skip_serializing_if = "Option::is_none")]
85    pub has_preprocessor: Option<bool>,
86    #[serde(rename = "on_behalf_of_email", skip_serializing_if = "Option::is_none")]
87    pub on_behalf_of_email: Option<String>,
88    /// When true and the caller is a member of the 'wm_deployers' group, preserves the original on_behalf_of_email value instead of overwriting it.
89    #[serde(rename = "preserve_on_behalf_of", skip_serializing_if = "Option::is_none")]
90    pub preserve_on_behalf_of: Option<bool>,
91    #[serde(rename = "assets", skip_serializing_if = "Option::is_none")]
92    pub assets: Option<Vec<models::NewScriptAssetsInner>>,
93    /// Additional script modules keyed by relative file path
94    #[serde(rename = "modules", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
95    pub modules: Option<Option<std::collections::HashMap<String, models::ScriptModule>>>,
96    #[serde(rename = "labels", skip_serializing_if = "Option::is_none")]
97    pub labels: Option<Vec<String>>,
98    /// When true (set by the CLI / git sync), deploying this script does not delete an existing user draft at the same path.
99    #[serde(rename = "skip_draft_deletion", skip_serializing_if = "Option::is_none")]
100    pub skip_draft_deletion: Option<bool>,
101}
102
103impl NewScript {
104    pub fn new(path: String, summary: String, content: String, language: models::ScriptLang) -> NewScript {
105        NewScript {
106            path,
107            parent_hash: None,
108            auto_parent: None,
109            summary,
110            description: None,
111            content,
112            schema: None,
113            is_template: None,
114            lock: None,
115            language,
116            kind: None,
117            tag: None,
118            envs: None,
119            concurrent_limit: None,
120            concurrency_time_window_s: None,
121            cache_ttl: None,
122            cache_ignore_s3_path: None,
123            dedicated_worker: None,
124            ws_error_handler_muted: None,
125            priority: None,
126            restart_unless_cancelled: None,
127            timeout: None,
128            delete_after_secs: None,
129            deployment_message: None,
130            concurrency_key: None,
131            debounce_key: None,
132            debounce_delay_s: None,
133            debounce_args_to_accumulate: None,
134            max_total_debouncing_time: None,
135            max_total_debounces_amount: None,
136            visible_to_runner_only: None,
137            auto_kind: None,
138            codebase: None,
139            has_preprocessor: None,
140            on_behalf_of_email: None,
141            preserve_on_behalf_of: None,
142            assets: None,
143            modules: None,
144            labels: None,
145            skip_draft_deletion: None,
146        }
147    }
148}
149/// 
150#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
151pub enum Kind {
152    #[serde(rename = "script")]
153    Script,
154    #[serde(rename = "failure")]
155    Failure,
156    #[serde(rename = "trigger")]
157    Trigger,
158    #[serde(rename = "command")]
159    Command,
160    #[serde(rename = "approval")]
161    Approval,
162    #[serde(rename = "preprocessor")]
163    Preprocessor,
164}
165
166impl Default for Kind {
167    fn default() -> Kind {
168        Self::Script
169    }
170}
171