Struct ScheduleDefinition

pub struct ScheduleDefinition {
    pub job_timing_policy: ScheduleJobTimingPolicy,
    pub job_creation_policy: ScheduleJobCreationPolicy,
    pub labels: IndexMap<String, String>,
    pub time_range: Option<ScheduleTimeRange>,
    pub metadata_json: Option<String>,
    pub propagate_labels_to_jobs: bool,
}

A new schedule.

Fields

job_timing_policy: ScheduleJobTimingPolicy

Scheduling policy for the schedule.

job_creation_policy: ScheduleJobCreationPolicy

Policy for new jobs created by the schedule.

labels: IndexMap<String, String>

Labels of the schedule.

time_range: Option<ScheduleTimeRange>

The time range for the schedule.

The schedule must not start before start and must end before end.

metadata_json: Option<String>

Arbitrary metadata in JSON format.

propagate_labels_to_jobs: bool

Whether to copy schedule labels to created jobs.

Labels are not overwritten if they already exist on the job.

Note that this is a client-side operation that is done before the schedule is submitted to the server for creation.

By default, this is true.

Implementations

impl ScheduleDefinition

pub fn immediate(self) -> Self

Set the schedule to immediately create a job when started.

This is a no-op for timing policies that do not support it.

pub fn start_after(self, start: SystemTime) -> Self

Set a start time for the schedule.

pub fn end_before(self, end: SystemTime) -> Self

Set an end time for the schedule.

pub fn with_label( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Add a label to the schedule.

Note that this will not set any labels for jobs created by the schedule.

pub fn with_label_json( self, key: impl Into<String>, value: impl Serialize, ) -> Self

Add a JSON label to the schedule.

Panics

If the value cannot be serialized to JSON.

pub fn replace_metadata(self, metadata: impl Serialize) -> Self

Set additional metadata for the schedule.

Note that this will replace any existing metadata.

Panics

If the metadata cannot be serialized to JSON.

pub fn propagate_labels(self, propagate: bool) -> Self

Whether to propagate schedule labels to created jobs.

Labels are not overwritten if they already exist on the job.

Note that this is a client-side operation that is done before the schedule is submitted to the server for creation.

By default, this is true.

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 From<ScheduleDefinition> for ScheduleDefinition

fn from(definition: ScheduleDefinition) -> Self

Converts to this type from the input type.