Skip to main content

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.654.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 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    /// Initial offset behavior when consumer group has no committed offset. 'latest' starts from new messages only, 'earliest' starts from the beginning.
28    #[serde(rename = "auto_offset_reset", skip_serializing_if = "Option::is_none")]
29    pub auto_offset_reset: Option<AutoOffsetReset>,
30    /// ID of the server currently handling this trigger (internal)
31    #[serde(rename = "server_id", skip_serializing_if = "Option::is_none")]
32    pub server_id: Option<String>,
33    /// Timestamp of last server heartbeat (internal)
34    #[serde(rename = "last_server_ping", skip_serializing_if = "Option::is_none")]
35    pub last_server_ping: Option<String>,
36    /// Last error message if the trigger failed
37    #[serde(rename = "error", skip_serializing_if = "Option::is_none")]
38    pub error: Option<String>,
39    /// Path to a script or flow to run when the triggered job fails
40    #[serde(rename = "error_handler_path", skip_serializing_if = "Option::is_none")]
41    pub error_handler_path: Option<String>,
42    /// The arguments to pass to the script or flow
43    #[serde(rename = "error_handler_args", skip_serializing_if = "Option::is_none")]
44    pub error_handler_args: Option<std::collections::HashMap<String, serde_json::Value>>,
45    #[serde(rename = "retry", skip_serializing_if = "Option::is_none")]
46    pub retry: Option<Box<models::Retry>>,
47    /// The unique path identifier for this trigger
48    #[serde(rename = "path")]
49    pub path: String,
50    /// Path to the script or flow to execute when triggered
51    #[serde(rename = "script_path")]
52    pub script_path: String,
53    /// Email of the user who owns this trigger, used for permissioned_as
54    #[serde(rename = "email")]
55    pub email: String,
56    /// Additional permissions for this trigger
57    #[serde(rename = "extra_perms")]
58    pub extra_perms: std::collections::HashMap<String, bool>,
59    /// The workspace this trigger belongs to
60    #[serde(rename = "workspace_id")]
61    pub workspace_id: String,
62    /// Username of the last person who edited this trigger
63    #[serde(rename = "edited_by")]
64    pub edited_by: String,
65    /// Timestamp of the last edit
66    #[serde(rename = "edited_at")]
67    pub edited_at: String,
68    /// True if script_path points to a flow, false if it points to a script
69    #[serde(rename = "is_flow")]
70    pub is_flow: bool,
71    #[serde(rename = "mode")]
72    pub mode: models::TriggerMode,
73}
74
75impl KafkaTrigger {
76    pub fn new(kafka_resource_path: String, group_id: String, topics: Vec<String>, filters: Vec<serde_json::Value>, path: String, script_path: String, email: String, extra_perms: std::collections::HashMap<String, bool>, workspace_id: String, edited_by: String, edited_at: String, is_flow: bool, mode: models::TriggerMode) -> KafkaTrigger {
77        KafkaTrigger {
78            kafka_resource_path,
79            group_id,
80            topics,
81            filters,
82            auto_offset_reset: None,
83            server_id: None,
84            last_server_ping: None,
85            error: None,
86            error_handler_path: None,
87            error_handler_args: None,
88            retry: None,
89            path,
90            script_path,
91            email,
92            extra_perms,
93            workspace_id,
94            edited_by,
95            edited_at,
96            is_flow,
97            mode,
98        }
99    }
100}
101/// Initial offset behavior when consumer group has no committed offset. 'latest' starts from new messages only, 'earliest' starts from the beginning.
102#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
103pub enum AutoOffsetReset {
104    #[serde(rename = "latest")]
105    Latest,
106    #[serde(rename = "earliest")]
107    Earliest,
108}
109
110impl Default for AutoOffsetReset {
111    fn default() -> AutoOffsetReset {
112        Self::Latest
113    }
114}
115