Struct NewWebsocketTrigger 

pub struct NewWebsocketTrigger {

    pub path: String,
    pub script_path: String,
    pub is_flow: bool,
    pub url: String,
    pub mode: Option<TriggerMode>,
    pub filters: Vec<NewWebsocketTriggerFiltersInner>,
    pub initial_messages: Option<Vec<WebsocketTriggerInitialMessage>>,
    pub url_runnable_args: Option<HashMap<String, Value>>,
    pub can_return_message: bool,
    pub can_return_error_result: bool,
    pub error_handler_path: Option<String>,
    pub error_handler_args: Option<HashMap<String, Value>>,
    pub retry: Option<Box<Retry>>,
}

Fields

path: String

The unique path identifier for this trigger

script_path: String

Path to the script or flow to execute when a message is received

is_flow: bool

True if script_path points to a flow, false if it points to a script

url: String

The WebSocket URL to connect to (can be a static URL or computed by a runnable)

mode: Option<TriggerMode>

filters: Vec<NewWebsocketTriggerFiltersInner>

Array of key-value filters to match incoming messages (only matching messages trigger the script)

initial_messages: Option<Vec<WebsocketTriggerInitialMessage>>

Messages to send immediately after connecting (can be raw strings or computed by runnables)

url_runnable_args: Option<HashMap<String, Value>>

The arguments to pass to the script or flow

can_return_message: bool

If true, the script can return a message to send back through the WebSocket

can_return_error_result: bool

If true, error results are sent back through the WebSocket

error_handler_path: Option<String>

Path to a script or flow to run when the triggered job fails

error_handler_args: Option<HashMap<String, Value>>

The arguments to pass to the script or flow

retry: Option<Box<Retry>>

Implementations

impl NewWebsocketTrigger

pub fn new( path: String, script_path: String, is_flow: bool, url: String, filters: Vec<NewWebsocketTriggerFiltersInner>, can_return_message: bool, can_return_error_result: bool, ) -> NewWebsocketTrigger

Trait Implementations

impl Clone for NewWebsocketTrigger

fn clone(&self) -> NewWebsocketTrigger

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NewWebsocketTrigger

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for NewWebsocketTrigger

fn default() -> NewWebsocketTrigger

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NewWebsocketTrigger

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for NewWebsocketTrigger

fn eq(&self, other: &NewWebsocketTrigger) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for NewWebsocketTrigger

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for NewWebsocketTrigger