Struct ScheduleDefinition

pub struct ScheduleDefinition {
    pub policy: SchedulePolicy,
    pub immediate: bool,
    pub missed_tasks: MissedTasksPolicy,
    pub new_task: NewTask,
    pub labels: HashMap<String, Value>,
}

A schedule supports repeatedly spawning jobs based on the given settings.

Fields

policy: SchedulePolicy

The task schedule policy.

immediate: bool

Whether to immediately spawn a task when the schedule is first processed.

missed_tasks: MissedTasksPolicy

The policy for missed tasks.

new_task: NewTask

Parameters for newly spawned tasks.

labels: HashMap<String, Value>

Schedule labels.

Implementations

impl ScheduleDefinition

pub fn new(policy: SchedulePolicy, new_task: NewTask) -> Self

Create a new schedule.

pub fn immediate(self, immediate: bool) -> Self

Set whether a task should be immediately scheduled when the schedule is added.

pub fn on_missed_tasks(self, policy: MissedTasksPolicy) -> Self

Set the missed tasks policy.

pub fn with_label(self, name: &str, value: impl Serialize) -> Self

Set a label value.

Panics

Panics if the value is not JSON-serializable.

Trait Implementations

impl Clone for ScheduleDefinition

fn clone(&self) -> ScheduleDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScheduleDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ScheduleDefinition

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ScheduleDefinition

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

where __S: Serializer,

Serialize this value into the given Serde serializer.