1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
/*
* Windmill API
*
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
*
* The version of the OpenAPI document: 1.792.0
* Contact: contact@windmill.dev
* Generated by: https://openapi-generator.tech
*/
use crate::models;
use serde::{Deserialize, Serialize};
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
pub struct EditWebsocketTrigger {
/// The WebSocket URL to connect to (can be a static URL or computed by a runnable)
#[serde(rename = "url")]
pub url: String,
/// 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.
#[serde(rename = "path")]
pub path: String,
/// Path to the script or flow to execute when a message is received
#[serde(rename = "script_path")]
pub script_path: String,
/// True if script_path points to a flow, false if it points to a script
#[serde(rename = "is_flow")]
pub is_flow: bool,
/// 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`.
#[serde(rename = "filters")]
pub filters: Vec<models::TriggerFilter>,
/// 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.
#[serde(rename = "filter_logic", skip_serializing_if = "Option::is_none")]
pub filter_logic: Option<FilterLogic>,
/// Messages to send immediately after connecting (can be raw strings or computed by runnables)
#[serde(rename = "initial_messages", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
pub initial_messages: Option<Option<Vec<models::WebsocketTriggerInitialMessage>>>,
/// The arguments to pass to the script or flow
#[serde(rename = "url_runnable_args", skip_serializing_if = "Option::is_none")]
pub url_runnable_args: Option<std::collections::HashMap<String, serde_json::Value>>,
/// If true, the script can return a message to send back through the WebSocket
#[serde(rename = "can_return_message")]
pub can_return_message: bool,
/// If true, error results are sent back through the WebSocket
#[serde(rename = "can_return_error_result")]
pub can_return_error_result: bool,
#[serde(rename = "heartbeat", skip_serializing_if = "Option::is_none")]
pub heartbeat: Option<Box<models::WebsocketHeartbeat>>,
/// Path to a script or flow to run when the triggered job fails
#[serde(rename = "error_handler_path", skip_serializing_if = "Option::is_none")]
pub error_handler_path: Option<String>,
/// The arguments to pass to the script or flow
#[serde(rename = "error_handler_args", skip_serializing_if = "Option::is_none")]
pub error_handler_args: Option<std::collections::HashMap<String, serde_json::Value>>,
#[serde(rename = "retry", skip_serializing_if = "Option::is_none")]
pub retry: Option<Box<models::Retry>>,
/// The user or group this trigger runs as. Used during deployment to preserve the original trigger owner.
#[serde(rename = "permissioned_as", skip_serializing_if = "Option::is_none")]
pub permissioned_as: Option<String>,
/// When true and the caller is a member of the 'wm_deployers' group, preserves the original permissioned_as value instead of overwriting it.
#[serde(rename = "preserve_permissioned_as", skip_serializing_if = "Option::is_none")]
pub preserve_permissioned_as: Option<bool>,
#[serde(rename = "labels", skip_serializing_if = "Option::is_none")]
pub labels: Option<Vec<String>>,
}
impl EditWebsocketTrigger {
pub fn new(url: String, path: String, script_path: String, is_flow: bool, filters: Vec<models::TriggerFilter>, can_return_message: bool, can_return_error_result: bool) -> EditWebsocketTrigger {
EditWebsocketTrigger {
url,
path,
script_path,
is_flow,
filters,
filter_logic: None,
initial_messages: None,
url_runnable_args: None,
can_return_message,
can_return_error_result,
heartbeat: None,
error_handler_path: None,
error_handler_args: None,
retry: None,
permissioned_as: None,
preserve_permissioned_as: None,
labels: None,
}
}
}
/// 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.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum FilterLogic {
#[serde(rename = "and")]
And,
#[serde(rename = "or")]
Or,
}
impl Default for FilterLogic {
fn default() -> FilterLogic {
Self::And
}
}