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.863.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 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.
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    /// 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`.
35    #[serde(rename = "filters")]
36    pub filters: Vec<models::TriggerFilter>,
37    /// 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.
38    #[serde(rename = "filter_logic", skip_serializing_if = "Option::is_none")]
39    pub filter_logic: Option<FilterLogic>,
40    /// Whether a message the filters cannot read (not UTF-8, or not JSON) still runs the target, as if the trigger had no filters. A preprocessor then finds the reason in `event.filter_error`. When false, such a message is skipped.
41    #[serde(rename = "run_on_filter_error", skip_serializing_if = "Option::is_none")]
42    pub run_on_filter_error: Option<bool>,
43    /// Initial offset behavior when consumer group has no committed offset.
44    #[serde(rename = "auto_offset_reset", skip_serializing_if = "Option::is_none")]
45    pub auto_offset_reset: Option<AutoOffsetReset>,
46    /// When true (default), offsets are committed automatically after receiving each message. When false, you must manually commit offsets using the commit_offsets endpoint.
47    #[serde(rename = "auto_commit", skip_serializing_if = "Option::is_none")]
48    pub auto_commit: Option<bool>,
49    #[serde(rename = "mode", skip_serializing_if = "Option::is_none")]
50    pub mode: Option<models::TriggerMode>,
51    /// Path to a script to run when the triggered job fails. A bare path, without the script/ or flow/ prefix a schedule error handler takes; it cannot be a flow.
52    #[serde(rename = "error_handler_path", skip_serializing_if = "Option::is_none")]
53    pub error_handler_path: Option<String>,
54    /// The arguments to pass to the script or flow
55    #[serde(rename = "error_handler_args", skip_serializing_if = "Option::is_none")]
56    pub error_handler_args: Option<std::collections::HashMap<String, serde_json::Value>>,
57    #[serde(rename = "retry", skip_serializing_if = "Option::is_none")]
58    pub retry: Option<Box<models::Retry>>,
59    /// The user or group this trigger runs as. Used during deployment to preserve the original trigger owner.
60    #[serde(rename = "permissioned_as", skip_serializing_if = "Option::is_none")]
61    pub permissioned_as: Option<String>,
62    /// When true and the caller is a member of the 'wm_deployers' group, preserves the original permissioned_as value instead of overwriting it.
63    #[serde(rename = "preserve_permissioned_as", skip_serializing_if = "Option::is_none")]
64    pub preserve_permissioned_as: Option<bool>,
65    #[serde(rename = "labels", skip_serializing_if = "Option::is_none")]
66    pub labels: Option<Vec<String>>,
67}
68
69impl NewKafkaTrigger {
70    pub fn new(path: String, script_path: String, is_flow: bool, kafka_resource_path: String, group_id: String, topics: Vec<String>, filters: Vec<models::TriggerFilter>) -> NewKafkaTrigger {
71        NewKafkaTrigger {
72            path,
73            script_path,
74            is_flow,
75            kafka_resource_path,
76            group_id,
77            topics,
78            filters,
79            filter_logic: None,
80            run_on_filter_error: None,
81            auto_offset_reset: None,
82            auto_commit: None,
83            mode: None,
84            error_handler_path: None,
85            error_handler_args: None,
86            retry: None,
87            permissioned_as: None,
88            preserve_permissioned_as: None,
89            labels: None,
90        }
91    }
92}
93/// 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.
94#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
95pub enum FilterLogic {
96    #[serde(rename = "and")]
97    And,
98    #[serde(rename = "or")]
99    Or,
100}
101
102impl Default for FilterLogic {
103    fn default() -> FilterLogic {
104        Self::And
105    }
106}
107/// Initial offset behavior when consumer group has no committed offset.
108#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
109pub enum AutoOffsetReset {
110    #[serde(rename = "latest")]
111    Latest,
112    #[serde(rename = "earliest")]
113    Earliest,
114}
115
116impl Default for AutoOffsetReset {
117    fn default() -> AutoOffsetReset {
118        Self::Latest
119    }
120}
121
windmill_api/models/new_kafka_trigger.rs

windmill_api/models/
new_kafka_trigger.rs
