Struct ScheduleSpec 

pub struct ScheduleSpec {
    pub workflow: String,
    pub version: Option<String>,
    pub input: Value,
    pub cron: Option<String>,
    pub interval: Option<String>,
    pub timezone: Option<String>,
    pub overlap: Overlap,
    pub catchup: Catchup,
    pub start_at: Option<String>,
    pub end_at: Option<String>,
    pub jitter: Option<String>,
    pub description: Option<String>,
}

A schedule’s specification: the JSON of POST /v1/schedules (without schedule_id and paused), stored in orbit_schedules.spec.

Fields

workflow: String

version: Option<String>

Default: the latest registered version at each fire.

input: Value

cron: Option<String>

Five fields: minute hour day-of-month month day-of-week.

interval: Option<String>

A fixed interval such as 15m or 1h30m, aligned to start_at (or to the Unix epoch).

timezone: Option<String>

IANA time zone for cron, e.g. Europe/Berlin. Default UTC.

overlap: Overlap

catchup: Catchup

start_at: Option<String>

RFC 3339: no occurrence before this time.

end_at: Option<String>

RFC 3339: no occurrence after this time; the schedule then ends.

jitter: Option<String>

Delay each fire by a pseudo-random amount below this duration, derived from the schedule id and the occurrence (the same on every server).

description: Option<String>

Implementations

impl ScheduleSpec

pub fn plan(&self) -> Result<Plan>

Check the timing fields and compile them.

Trait Implementations

impl Clone for ScheduleSpec

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScheduleSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ScheduleSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ScheduleSpec

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ScheduleSpec

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 ScheduleSpec