windmill_api/models/
get_websocket_trigger_200_response.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.816.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 GetWebsocketTrigger200Response {
16    /// The WebSocket URL to connect to (can be a static URL or computed by a runnable)
17    #[serde(rename = "url")]
18    pub url: String,
19    /// ID of the server currently handling this trigger (internal)
20    #[serde(rename = "server_id", skip_serializing_if = "Option::is_none")]
21    pub server_id: Option<String>,
22    /// Timestamp of last server heartbeat (internal)
23    #[serde(rename = "last_server_ping", skip_serializing_if = "Option::is_none")]
24    pub last_server_ping: Option<String>,
25    /// Last error message if the trigger failed
26    #[serde(rename = "error", skip_serializing_if = "Option::is_none")]
27    pub error: Option<String>,
28    /// Filters to match incoming messages (only matching messages trigger the script). Each entry is either a leaf `{key, value}` (top-level field) or `{path, value}` (dotted path into nested objects), or a group `{any_of: [...]}` / `{all_of: [...]}` / `{none_of: [...]}` nesting more entries. Entries at the top level are combined with `filter_logic`.
29    #[serde(rename = "filters")]
30    pub filters: Vec<models::TriggerFilter>,
31    /// Logic to apply when evaluating the top-level filters. 'and' requires all of them to match, 'or' requires any of them to match. Nested `any_of`/`all_of`/`none_of` groups carry their own logic.
32    #[serde(rename = "filter_logic", skip_serializing_if = "Option::is_none")]
33    pub filter_logic: Option<FilterLogic>,
34    /// Messages to send immediately after connecting (can be raw strings or computed by runnables)
35    #[serde(rename = "initial_messages", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
36    pub initial_messages: Option<Option<Vec<models::WebsocketTriggerInitialMessage>>>,
37    /// The arguments to pass to the script or flow
38    #[serde(rename = "url_runnable_args", skip_serializing_if = "Option::is_none")]
39    pub url_runnable_args: Option<std::collections::HashMap<String, serde_json::Value>>,
40    /// If true, the script can return a message to send back through the WebSocket
41    #[serde(rename = "can_return_message")]
42    pub can_return_message: bool,
43    /// If true, error results are sent back through the WebSocket
44    #[serde(rename = "can_return_error_result")]
45    pub can_return_error_result: bool,
46    #[serde(rename = "heartbeat", skip_serializing_if = "Option::is_none")]
47    pub heartbeat: Option<Box<models::WebsocketHeartbeat>>,
48    /// Path to a script to run when the triggered job fails. A bare path, without the script/ or flow/ prefix a schedule error handler takes; it cannot be a flow.
49    #[serde(rename = "error_handler_path", skip_serializing_if = "Option::is_none")]
50    pub error_handler_path: Option<String>,
51    /// The arguments to pass to the script or flow
52    #[serde(rename = "error_handler_args", skip_serializing_if = "Option::is_none")]
53    pub error_handler_args: Option<std::collections::HashMap<String, serde_json::Value>>,
54    #[serde(rename = "retry", skip_serializing_if = "Option::is_none")]
55    pub retry: Option<Box<models::Retry>>,
56    /// The unique Windmill path for this trigger. Must be of the form `u/<user>/<path>` or `f/<folder>/<path>`. This is the trigger object path, not the HTTP route path.
57    #[serde(rename = "path")]
58    pub path: String,
59    /// Path to the script or flow to execute when triggered
60    #[serde(rename = "script_path")]
61    pub script_path: String,
62    /// The user or group this trigger runs as (permissioned_as)
63    #[serde(rename = "permissioned_as")]
64    pub permissioned_as: String,
65    /// Additional permissions for this trigger
66    #[serde(rename = "extra_perms")]
67    pub extra_perms: std::collections::HashMap<String, bool>,
68    /// The workspace this trigger belongs to
69    #[serde(rename = "workspace_id")]
70    pub workspace_id: String,
71    /// Username of the last person who edited this trigger
72    #[serde(rename = "edited_by")]
73    pub edited_by: String,
74    /// Timestamp of the last edit
75    #[serde(rename = "edited_at")]
76    pub edited_at: String,
77    /// True if script_path points to a flow, false if it points to a script
78    #[serde(rename = "is_flow")]
79    pub is_flow: bool,
80    #[serde(rename = "mode")]
81    pub mode: models::TriggerMode,
82    #[serde(rename = "labels", skip_serializing_if = "Option::is_none")]
83    pub labels: Option<Vec<String>>,
84    /// True when this row is a per-user draft with no deployed trigger at the same path. Set by list endpoints when `include_draft_only=true` synthesizes the row from the draft. Frontend renders a \"Draft\" badge. 
85    #[serde(rename = "draft_only", skip_serializing_if = "Option::is_none")]
86    pub draft_only: Option<bool>,
87    #[serde(rename = "is_draft")]
88    pub is_draft: bool,
89    #[serde(rename = "draft_saved_at", skip_serializing_if = "Option::is_none")]
90    pub draft_saved_at: Option<String>,
91    /// The deployed version the draft forked from, as text whatever the kind (script hash, flow version id, app version id). Compare to the deployed head to tell a draft that is behind. Absent when there is no draft or it was never forked from a deploy. 
92    #[serde(rename = "draft_base", skip_serializing_if = "Option::is_none")]
93    pub draft_base: Option<String>,
94    #[serde(rename = "no_deployed", skip_serializing_if = "Option::is_none")]
95    pub no_deployed: Option<bool>,
96    #[serde(rename = "draft", skip_serializing_if = "Option::is_none")]
97    pub draft: Option<std::collections::HashMap<String, serde_json::Value>>,
98    /// Other workspace users (and the legacy NULL-email row, if any) with a saved draft at the same path. Populated only on the authed user's \"get by path\" responses for kinds the editor surfaces a fork banner for (script, flow, app, raw_app). Empty / omitted for kinds without that UI. 
99    #[serde(rename = "other_drafts_users", skip_serializing_if = "Option::is_none")]
100    pub other_drafts_users: Option<Vec<models::UserDraftOverlayOtherDraftsUsersInner>>,
101}
102
103impl GetWebsocketTrigger200Response {
104    pub fn new(url: String, filters: Vec<models::TriggerFilter>, can_return_message: bool, can_return_error_result: bool, path: String, script_path: String, permissioned_as: String, extra_perms: std::collections::HashMap<String, bool>, workspace_id: String, edited_by: String, edited_at: String, is_flow: bool, mode: models::TriggerMode, is_draft: bool) -> GetWebsocketTrigger200Response {
105        GetWebsocketTrigger200Response {
106            url,
107            server_id: None,
108            last_server_ping: None,
109            error: None,
110            filters,
111            filter_logic: None,
112            initial_messages: None,
113            url_runnable_args: None,
114            can_return_message,
115            can_return_error_result,
116            heartbeat: None,
117            error_handler_path: None,
118            error_handler_args: None,
119            retry: None,
120            path,
121            script_path,
122            permissioned_as,
123            extra_perms,
124            workspace_id,
125            edited_by,
126            edited_at,
127            is_flow,
128            mode,
129            labels: None,
130            draft_only: None,
131            is_draft,
132            draft_saved_at: None,
133            draft_base: None,
134            no_deployed: None,
135            draft: None,
136            other_drafts_users: None,
137        }
138    }
139}
140/// Logic to apply when evaluating the top-level filters. 'and' requires all of them to match, 'or' requires any of them to match. Nested `any_of`/`all_of`/`none_of` groups carry their own logic.
141#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
142pub enum FilterLogic {
143    #[serde(rename = "and")]
144    And,
145    #[serde(rename = "or")]
146    Or,
147}
148
149impl Default for FilterLogic {
150    fn default() -> FilterLogic {
151        Self::And
152    }
153}
154
windmill_api/models/get_websocket_trigger_200_response.rs

windmill_api/models/
get_websocket_trigger_200_response.rs
