windmill_api/models/
new_schedule.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.539.1
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 NewSchedule {
16    /// The path where the schedule will be created
17    #[serde(rename = "path")]
18    pub path: String,
19    /// The cron schedule to trigger the script or flow. Should include seconds.
20    #[serde(rename = "schedule")]
21    pub schedule: String,
22    /// The timezone to use for the cron schedule
23    #[serde(rename = "timezone")]
24    pub timezone: String,
25    /// The path to the script or flow to trigger
26    #[serde(rename = "script_path")]
27    pub script_path: String,
28    /// Whether the schedule is for a flow
29    #[serde(rename = "is_flow")]
30    pub is_flow: bool,
31    /// The arguments to pass to the script or flow
32    #[serde(rename = "args")]
33    pub args: std::collections::HashMap<String, serde_json::Value>,
34    /// Whether the schedule is enabled
35    #[serde(rename = "enabled", skip_serializing_if = "Option::is_none")]
36    pub enabled: Option<bool>,
37    /// The path to the script or flow to trigger on failure
38    #[serde(rename = "on_failure", skip_serializing_if = "Option::is_none")]
39    pub on_failure: Option<String>,
40    /// The number of times to retry on failure
41    #[serde(rename = "on_failure_times", skip_serializing_if = "Option::is_none")]
42    pub on_failure_times: Option<f64>,
43    /// Whether the schedule should only run on the exact time
44    #[serde(rename = "on_failure_exact", skip_serializing_if = "Option::is_none")]
45    pub on_failure_exact: Option<bool>,
46    /// The arguments to pass to the script or flow
47    #[serde(rename = "on_failure_extra_args", skip_serializing_if = "Option::is_none")]
48    pub on_failure_extra_args: Option<std::collections::HashMap<String, serde_json::Value>>,
49    /// The path to the script or flow to trigger on recovery
50    #[serde(rename = "on_recovery", skip_serializing_if = "Option::is_none")]
51    pub on_recovery: Option<String>,
52    /// The number of times to retry on recovery
53    #[serde(rename = "on_recovery_times", skip_serializing_if = "Option::is_none")]
54    pub on_recovery_times: Option<f64>,
55    /// The arguments to pass to the script or flow
56    #[serde(rename = "on_recovery_extra_args", skip_serializing_if = "Option::is_none")]
57    pub on_recovery_extra_args: Option<std::collections::HashMap<String, serde_json::Value>>,
58    /// The path to the script or flow to trigger on success
59    #[serde(rename = "on_success", skip_serializing_if = "Option::is_none")]
60    pub on_success: Option<String>,
61    /// The arguments to pass to the script or flow
62    #[serde(rename = "on_success_extra_args", skip_serializing_if = "Option::is_none")]
63    pub on_success_extra_args: Option<std::collections::HashMap<String, serde_json::Value>>,
64    /// Whether the WebSocket error handler is muted
65    #[serde(rename = "ws_error_handler_muted", skip_serializing_if = "Option::is_none")]
66    pub ws_error_handler_muted: Option<bool>,
67    #[serde(rename = "retry", skip_serializing_if = "Option::is_none")]
68    pub retry: Option<Box<models::Retry>>,
69    /// Whether the schedule should not run if a flow is already running
70    #[serde(rename = "no_flow_overlap", skip_serializing_if = "Option::is_none")]
71    pub no_flow_overlap: Option<bool>,
72    /// The summary of the schedule
73    #[serde(rename = "summary", skip_serializing_if = "Option::is_none")]
74    pub summary: Option<String>,
75    /// The description of the schedule
76    #[serde(rename = "description", skip_serializing_if = "Option::is_none")]
77    pub description: Option<String>,
78    /// The tag of the schedule
79    #[serde(rename = "tag", skip_serializing_if = "Option::is_none")]
80    pub tag: Option<String>,
81    /// The date and time the schedule will be paused until
82    #[serde(rename = "paused_until", skip_serializing_if = "Option::is_none")]
83    pub paused_until: Option<String>,
84    /// The version of the cron schedule to use (last is v2)
85    #[serde(rename = "cron_version", skip_serializing_if = "Option::is_none")]
86    pub cron_version: Option<String>,
87}
88
89impl NewSchedule {
90    pub fn new(path: String, schedule: String, timezone: String, script_path: String, is_flow: bool, args: std::collections::HashMap<String, serde_json::Value>) -> NewSchedule {
91        NewSchedule {
92            path,
93            schedule,
94            timezone,
95            script_path,
96            is_flow,
97            args,
98            enabled: None,
99            on_failure: None,
100            on_failure_times: None,
101            on_failure_exact: None,
102            on_failure_extra_args: None,
103            on_recovery: None,
104            on_recovery_times: None,
105            on_recovery_extra_args: None,
106            on_success: None,
107            on_success_extra_args: None,
108            ws_error_handler_muted: None,
109            retry: None,
110            no_flow_overlap: None,
111            summary: None,
112            description: None,
113            tag: None,
114            paused_until: None,
115            cron_version: None,
116        }
117    }
118}
119
windmill_api/models/new_schedule.rs

windmill_api/models/
new_schedule.rs
