Struct Schedule 

pub struct Schedule {

    pub path: String,
    pub edited_by: String,
    pub edited_at: String,
    pub schedule: String,
    pub timezone: String,
    pub enabled: bool,
    pub script_path: String,
    pub is_flow: bool,
    pub args: Option<HashMap<String, Value>>,
    pub extra_perms: HashMap<String, bool>,
    pub email: String,
    pub error: Option<String>,
    pub on_failure: Option<String>,
    pub on_failure_times: Option<f64>,
    pub on_failure_exact: Option<bool>,
    pub on_failure_extra_args: Option<HashMap<String, Value>>,
    pub on_recovery: Option<String>,
    pub on_recovery_times: Option<f64>,
    pub on_recovery_extra_args: Option<HashMap<String, Value>>,
    pub on_success: Option<String>,
    pub on_success_extra_args: Option<HashMap<String, Value>>,
    pub ws_error_handler_muted: Option<bool>,
    pub retry: Option<Box<Retry>>,
    pub summary: Option<String>,
    pub description: Option<String>,
    pub no_flow_overlap: Option<bool>,
    pub tag: Option<String>,
    pub paused_until: Option<String>,
    pub cron_version: Option<String>,
    pub dynamic_skip: Option<String>,
}

Fields

path: String

The unique path identifier for this schedule

edited_by: String

Username of the last person who edited this schedule

edited_at: String

Timestamp of the last edit

schedule: String

Cron expression with 6 fields (seconds, minutes, hours, day of month, month, day of week). Example ‘0 0 12 * * *’ for daily at noon

timezone: String

IANA timezone for the schedule (e.g., ‘UTC’, ‘Europe/Paris’, ‘America/New_York’)

enabled: bool

Whether the schedule is currently active and will trigger jobs

script_path: String

Path to the script or flow to execute when triggered

is_flow: bool

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

args: Option<HashMap<String, Value>>

The arguments to pass to the script or flow

extra_perms: HashMap<String, bool>

Additional permissions for this schedule

email: String

Email of the user who owns this schedule, used for permissioned_as

error: Option<String>

Last error message if the schedule failed to trigger

on_failure: Option<String>

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

on_failure_times: Option<f64>

Number of consecutive failures before the on_failure handler is triggered (default 1)

on_failure_exact: Option<bool>

If true, trigger on_failure handler only on exactly N failures, not on every failure after N

on_failure_extra_args: Option<HashMap<String, Value>>

The arguments to pass to the script or flow

on_recovery: Option<String>

Path to a script or flow to run when the schedule recovers after failures

on_recovery_times: Option<f64>

Number of consecutive successes before the on_recovery handler is triggered (default 1)

on_recovery_extra_args: Option<HashMap<String, Value>>

The arguments to pass to the script or flow

on_success: Option<String>

Path to a script or flow to run after each successful execution

on_success_extra_args: Option<HashMap<String, Value>>

The arguments to pass to the script or flow

ws_error_handler_muted: Option<bool>

If true, the workspace-level error handler will not be triggered for this schedule’s failures

retry: Option<Box<Retry>>

summary: Option<String>

Short summary describing the purpose of this schedule

description: Option<String>

Detailed description of what this schedule does

no_flow_overlap: Option<bool>

If true, skip this schedule’s execution if the previous run is still in progress (prevents concurrent runs)

tag: Option<String>

Worker tag to route jobs to specific worker groups

paused_until: Option<String>

ISO 8601 datetime until which the schedule is paused. Schedule resumes automatically after this time

cron_version: Option<String>

Cron parser version. Use ‘v2’ for extended syntax with additional features

dynamic_skip: Option<String>

Path to a script that validates scheduled datetimes. Receives scheduled_for datetime and returns boolean to skip (true) or run (false)

Implementations

impl Schedule

pub fn new( path: String, edited_by: String, edited_at: String, schedule: String, timezone: String, enabled: bool, script_path: String, is_flow: bool, extra_perms: HashMap<String, bool>, email: String, ) -> Schedule

Trait Implementations

impl Clone for Schedule

fn clone(&self) -> Schedule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Schedule

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

Formats the value using the given formatter.

impl Default for Schedule

fn default() -> Schedule

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Schedule

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Schedule

fn eq(&self, other: &Schedule) -> 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 Schedule

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 Schedule