windmill_api/models/
nats_trigger.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.727.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 NatsTrigger {
16    /// Path to the NATS resource containing connection configuration
17    #[serde(rename = "nats_resource_path")]
18    pub nats_resource_path: String,
19    /// If true, uses NATS JetStream for durable message delivery
20    #[serde(rename = "use_jetstream")]
21    pub use_jetstream: bool,
22    /// JetStream stream name (required when use_jetstream is true)
23    #[serde(rename = "stream_name", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
24    pub stream_name: Option<Option<String>>,
25    /// JetStream consumer name (required when use_jetstream is true)
26    #[serde(rename = "consumer_name", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
27    pub consumer_name: Option<Option<String>>,
28    /// Array of NATS subjects to subscribe to
29    #[serde(rename = "subjects")]
30    pub subjects: Vec<String>,
31    /// ID of the server currently handling this trigger (internal)
32    #[serde(rename = "server_id", skip_serializing_if = "Option::is_none")]
33    pub server_id: Option<String>,
34    /// Timestamp of last server heartbeat (internal)
35    #[serde(rename = "last_server_ping", skip_serializing_if = "Option::is_none")]
36    pub last_server_ping: Option<String>,
37    /// Last error message if the trigger failed
38    #[serde(rename = "error", skip_serializing_if = "Option::is_none")]
39    pub error: Option<String>,
40    /// Path to a script or flow to run when the triggered job fails
41    #[serde(rename = "error_handler_path", skip_serializing_if = "Option::is_none")]
42    pub error_handler_path: Option<String>,
43    /// The arguments to pass to the script or flow
44    #[serde(rename = "error_handler_args", skip_serializing_if = "Option::is_none")]
45    pub error_handler_args: Option<std::collections::HashMap<String, serde_json::Value>>,
46    #[serde(rename = "retry", skip_serializing_if = "Option::is_none")]
47    pub retry: Option<Box<models::Retry>>,
48    /// 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.
49    #[serde(rename = "path")]
50    pub path: String,
51    /// Path to the script or flow to execute when triggered
52    #[serde(rename = "script_path")]
53    pub script_path: String,
54    /// The user or group this trigger runs as (permissioned_as)
55    #[serde(rename = "permissioned_as")]
56    pub permissioned_as: String,
57    /// Additional permissions for this trigger
58    #[serde(rename = "extra_perms")]
59    pub extra_perms: std::collections::HashMap<String, bool>,
60    /// The workspace this trigger belongs to
61    #[serde(rename = "workspace_id")]
62    pub workspace_id: String,
63    /// Username of the last person who edited this trigger
64    #[serde(rename = "edited_by")]
65    pub edited_by: String,
66    /// Timestamp of the last edit
67    #[serde(rename = "edited_at")]
68    pub edited_at: String,
69    /// True if script_path points to a flow, false if it points to a script
70    #[serde(rename = "is_flow")]
71    pub is_flow: bool,
72    #[serde(rename = "mode")]
73    pub mode: models::TriggerMode,
74    #[serde(rename = "labels", skip_serializing_if = "Option::is_none")]
75    pub labels: Option<Vec<String>>,
76    /// 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. 
77    #[serde(rename = "draft_only", skip_serializing_if = "Option::is_none")]
78    pub draft_only: Option<bool>,
79    /// True when the authed user has a per-user draft at this path (over a deployed row or a synthesized draft-only row). Frontend appends a `*` to the displayed name. 
80    #[serde(rename = "is_draft", skip_serializing_if = "Option::is_none")]
81    pub is_draft: Option<bool>,
82}
83
84impl NatsTrigger {
85    pub fn new(nats_resource_path: String, use_jetstream: bool, subjects: Vec<String>, 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) -> NatsTrigger {
86        NatsTrigger {
87            nats_resource_path,
88            use_jetstream,
89            stream_name: None,
90            consumer_name: None,
91            subjects,
92            server_id: None,
93            last_server_ping: None,
94            error: None,
95            error_handler_path: None,
96            error_handler_args: None,
97            retry: None,
98            path,
99            script_path,
100            permissioned_as,
101            extra_perms,
102            workspace_id,
103            edited_by,
104            edited_at,
105            is_flow,
106            mode,
107            labels: None,
108            draft_only: None,
109            is_draft: None,
110        }
111    }
112}
113
windmill_api/models/nats_trigger.rs

windmill_api/models/
nats_trigger.rs
