Struct TriggerSpec 

#[non_exhaustive]
pub struct TriggerSpec {
    pub type: Type,
    pub start_time: Option<Timestamp>,
    pub disabled: bool,
    pub max_retries: i32,
    pub trigger: Option<Trigger>,
    /* private fields */
}

Task scheduling and trigger settings.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

type: Type

Required. Immutable. Trigger type of the user-specified Task.

start_time: Option<Timestamp>

Optional. The first run of the task will be after this time. If not specified, the task will run shortly after being submitted if ON_DEMAND and based on the schedule if RECURRING.

disabled: bool

Optional. Prevent the task from executing. This does not cancel already running tasks. It is intended to temporarily disable RECURRING tasks.

max_retries: i32

Optional. Number of retry attempts before aborting. Set to zero to never attempt to retry a failed task.

trigger: Option<Trigger>

Trigger only applies for RECURRING tasks.

Implementations

impl TriggerSpec

pub fn new() -> Self

pub fn set_type<T: Into<Type>>(self, v: T) -> Self

Sets the value of r#type.

pub fn set_start_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of start_time.

pub fn set_or_clear_start_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of start_time.

pub fn set_disabled<T: Into<bool>>(self, v: T) -> Self

Sets the value of disabled.

pub fn set_max_retries<T: Into<i32>>(self, v: T) -> Self

Sets the value of max_retries.

pub fn set_trigger<T: Into<Option<Trigger>>>(self, v: T) -> Self

Sets the value of trigger.

Note that all the setters affecting trigger are mutually exclusive.

pub fn schedule(&self) -> Option<&String>

The value of trigger if it holds a Schedule, None if the field is not set or holds a different branch.

pub fn set_schedule<T: Into<String>>(self, v: T) -> Self

Sets the value of trigger to hold a Schedule.

Note that all the setters affecting trigger are mutually exclusive.

Trait Implementations

impl Clone for TriggerSpec

fn clone(&self) -> TriggerSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TriggerSpec

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

Formats the value using the given formatter.

impl Default for TriggerSpec

fn default() -> TriggerSpec

Returns the “default value” for a type.

impl Message for TriggerSpec

fn typename() -> &'static str

The typename of this message.

impl PartialEq for TriggerSpec

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