Struct ScheduleDefinition

pub struct ScheduleDefinition {
    pub job_timing_policy: Option<ScheduleJobTimingPolicy>,
    pub job_creation_policy: Option<ScheduleJobCreationPolicy>,
    pub labels: Vec<ScheduleLabel>,
    pub time_range: Option<TimeRange>,
    pub metadata_json: Option<String>,
}

A schedule is a tool for executing jobs at a specific times.

Schedules create new jobs based on various criteria.

Fields

job_timing_policy: Option<ScheduleJobTimingPolicy>

The timing policy for the schedule.

job_creation_policy: Option<ScheduleJobCreationPolicy>

The policy for creating new jobs.

labels: Vec<ScheduleLabel>

The labels of the schedule.

time_range: Option<TimeRange>

The time range for the schedule.

The schedule will not create jobs outside of the time range. If the time range is not provided, the schedule will create jobs indefinitely.

metadata_json: Option<String>

Arbitrary metadata in JSON format.

Implementations

impl ScheduleDefinition

pub fn metadata_json(&self) -> &str

Returns the value of metadata_json, or the default value if metadata_json is unset.

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

fn default() -> Self

Returns the “default value” for a type.

impl Message for ScheduleDefinition

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl Name for ScheduleDefinition

const NAME: &'static str = "ScheduleDefinition"

Simple name for this Message. This name is the same as it appears in the source .proto file, e.g. FooBar.

const PACKAGE: &'static str = "ora.common.v1"

Package name this message type is contained in. They are domain-like and delimited by ., e.g. google.protobuf.

fn full_name() -> String

Fully-qualified unique name for this Message. It’s prefixed with the package name and names of any parent messages, e.g. google.rpc.BadRequest.FieldViolation. By default, this is the package name followed by the message name. Fully-qualified names must be unique within a domain of Type URLs.

fn type_url() -> String

Type URL for this Message, which by default is the full name with a leading slash, but may also include a leading domain name, e.g. type.googleapis.com/google.profile.Person. This can be used when serializing into the google.protobuf.Any type.

impl PartialEq for ScheduleDefinition

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