windmill_api/models/
kafka_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.674.2
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 KafkaTrigger {
16    /// Path to the Kafka resource containing connection configuration
17    #[serde(rename = "kafka_resource_path")]
18    pub kafka_resource_path: String,
19    /// Kafka consumer group ID for this trigger
20    #[serde(rename = "group_id")]
21    pub group_id: String,
22    /// Array of Kafka topic names to subscribe to
23    #[serde(rename = "topics")]
24    pub topics: Vec<String>,
25    #[serde(rename = "filters")]
26    pub filters: Vec<serde_json::Value>,
27    /// Logic to apply when evaluating filters. 'and' requires all filters to match, 'or' requires any filter to match.
28    #[serde(rename = "filter_logic", skip_serializing_if = "Option::is_none")]
29    pub filter_logic: Option<FilterLogic>,
30    /// Initial offset behavior when consumer group has no committed offset. 'latest' starts from new messages only, 'earliest' starts from the beginning.
31    #[serde(rename = "auto_offset_reset", skip_serializing_if = "Option::is_none")]
32    pub auto_offset_reset: Option<AutoOffsetReset>,
33    /// When true (default), offsets are committed automatically after receiving each message. When false, you must manually commit offsets using the commit_offsets endpoint.
34    #[serde(rename = "auto_commit", skip_serializing_if = "Option::is_none")]
35    pub auto_commit: Option<bool>,
36    /// ID of the server currently handling this trigger (internal)
37    #[serde(rename = "server_id", skip_serializing_if = "Option::is_none")]
38    pub server_id: Option<String>,
39    /// Timestamp of last server heartbeat (internal)
40    #[serde(rename = "last_server_ping", skip_serializing_if = "Option::is_none")]
41    pub last_server_ping: Option<String>,
42    /// Last error message if the trigger failed
43    #[serde(rename = "error", skip_serializing_if = "Option::is_none")]
44    pub error: Option<String>,
45    /// Path to a script or flow to run when the triggered job fails
46    #[serde(rename = "error_handler_path", skip_serializing_if = "Option::is_none")]
47    pub error_handler_path: Option<String>,
48    /// The arguments to pass to the script or flow
49    #[serde(rename = "error_handler_args", skip_serializing_if = "Option::is_none")]
50    pub error_handler_args: Option<std::collections::HashMap<String, serde_json::Value>>,
51    #[serde(rename = "retry", skip_serializing_if = "Option::is_none")]
52    pub retry: Option<Box<models::Retry>>,
53    /// The unique path identifier for this trigger
54    #[serde(rename = "path")]
55    pub path: String,
56    /// Path to the script or flow to execute when triggered
57    #[serde(rename = "script_path")]
58    pub script_path: String,
59    /// The user or group this trigger runs as (permissioned_as)
60    #[serde(rename = "permissioned_as")]
61    pub permissioned_as: String,
62    /// Additional permissions for this trigger
63    #[serde(rename = "extra_perms")]
64    pub extra_perms: std::collections::HashMap<String, bool>,
65    /// The workspace this trigger belongs to
66    #[serde(rename = "workspace_id")]
67    pub workspace_id: String,
68    /// Username of the last person who edited this trigger
69    #[serde(rename = "edited_by")]
70    pub edited_by: String,
71    /// Timestamp of the last edit
72    #[serde(rename = "edited_at")]
73    pub edited_at: String,
74    /// True if script_path points to a flow, false if it points to a script
75    #[serde(rename = "is_flow")]
76    pub is_flow: bool,
77    #[serde(rename = "mode")]
78    pub mode: models::TriggerMode,
79    #[serde(rename = "labels", skip_serializing_if = "Option::is_none")]
80    pub labels: Option<Vec<String>>,
81}
82
83impl KafkaTrigger {
84    pub fn new(kafka_resource_path: String, group_id: String, topics: Vec<String>, filters: Vec<serde_json::Value>, 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) -> KafkaTrigger {
85        KafkaTrigger {
86            kafka_resource_path,
87            group_id,
88            topics,
89            filters,
90            filter_logic: None,
91            auto_offset_reset: None,
92            auto_commit: None,
93            server_id: None,
94            last_server_ping: None,
95            error: None,
96            error_handler_path: None,
97            error_handler_args: None,
98            retry: None,
99            path,
100            script_path,
101            permissioned_as,
102            extra_perms,
103            workspace_id,
104            edited_by,
105            edited_at,
106            is_flow,
107            mode,
108            labels: None,
109        }
110    }
111}
112/// Logic to apply when evaluating filters. 'and' requires all filters to match, 'or' requires any filter to match.
113#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
114pub enum FilterLogic {
115    #[serde(rename = "and")]
116    And,
117    #[serde(rename = "or")]
118    Or,
119}
120
121impl Default for FilterLogic {
122    fn default() -> FilterLogic {
123        Self::And
124    }
125}
126/// Initial offset behavior when consumer group has no committed offset. 'latest' starts from new messages only, 'earliest' starts from the beginning.
127#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
128pub enum AutoOffsetReset {
129    #[serde(rename = "latest")]
130    Latest,
131    #[serde(rename = "earliest")]
132    Earliest,
133}
134
135impl Default for AutoOffsetReset {
136    fn default() -> AutoOffsetReset {
137        Self::Latest
138    }
139}
140
windmill_api/models/kafka_trigger.rs

windmill_api/models/
kafka_trigger.rs
