Skip to main content

windmill_api/models/
new_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 NewKafkaTrigger {
16    /// The unique path identifier for this trigger
17    #[serde(rename = "path")]
18    pub path: String,
19    /// Path to the script or flow to execute when a message is received
20    #[serde(rename = "script_path")]
21    pub script_path: String,
22    /// True if script_path points to a flow, false if it points to a script
23    #[serde(rename = "is_flow")]
24    pub is_flow: bool,
25    /// Path to the Kafka resource containing connection configuration
26    #[serde(rename = "kafka_resource_path")]
27    pub kafka_resource_path: String,
28    /// Kafka consumer group ID for this trigger
29    #[serde(rename = "group_id")]
30    pub group_id: String,
31    /// Array of Kafka topic names to subscribe to
32    #[serde(rename = "topics")]
33    pub topics: Vec<String>,
34    #[serde(rename = "filters")]
35    pub filters: Vec<models::NewWebsocketTriggerFiltersInner>,
36    /// Initial offset behavior when consumer group has no committed offset.
37    #[serde(rename = "auto_offset_reset", skip_serializing_if = "Option::is_none")]
38    pub auto_offset_reset: Option<AutoOffsetReset>,
39    #[serde(rename = "mode", skip_serializing_if = "Option::is_none")]
40    pub mode: Option<models::TriggerMode>,
41    /// Path to a script or flow to run when the triggered job fails
42    #[serde(rename = "error_handler_path", skip_serializing_if = "Option::is_none")]
43    pub error_handler_path: Option<String>,
44    /// The arguments to pass to the script or flow
45    #[serde(rename = "error_handler_args", skip_serializing_if = "Option::is_none")]
46    pub error_handler_args: Option<std::collections::HashMap<String, serde_json::Value>>,
47    #[serde(rename = "retry", skip_serializing_if = "Option::is_none")]
48    pub retry: Option<Box<models::Retry>>,
49    /// Email of the user who triggered jobs run as. Used during deployment to preserve the original trigger owner.
50    #[serde(rename = "email", skip_serializing_if = "Option::is_none")]
51    pub email: Option<String>,
52    /// When true and the caller is a member of the 'wm_deployers' group, preserves the original email value instead of overwriting it.
53    #[serde(rename = "preserve_email", skip_serializing_if = "Option::is_none")]
54    pub preserve_email: Option<bool>,
55}
56
57impl NewKafkaTrigger {
58    pub fn new(path: String, script_path: String, is_flow: bool, kafka_resource_path: String, group_id: String, topics: Vec<String>, filters: Vec<models::NewWebsocketTriggerFiltersInner>) -> NewKafkaTrigger {
59        NewKafkaTrigger {
60            path,
61            script_path,
62            is_flow,
63            kafka_resource_path,
64            group_id,
65            topics,
66            filters,
67            auto_offset_reset: None,
68            mode: None,
69            error_handler_path: None,
70            error_handler_args: None,
71            retry: None,
72            email: None,
73            preserve_email: None,
74        }
75    }
76}
77/// Initial offset behavior when consumer group has no committed offset.
78#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
79pub enum AutoOffsetReset {
80    #[serde(rename = "latest")]
81    Latest,
82    #[serde(rename = "earliest")]
83    Earliest,
84}
85
86impl Default for AutoOffsetReset {
87    fn default() -> AutoOffsetReset {
88        Self::Latest
89    }
90}
91