Struct Schedule

#[non_exhaustive]
pub struct Schedule {

    pub name: String,
    pub display_name: String,
    pub start_time: Option<Timestamp>,
    pub end_time: Option<Timestamp>,
    pub max_run_count: i64,
    pub started_run_count: i64,
    pub state: State,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub next_run_time: Option<Timestamp>,
    pub last_pause_time: Option<Timestamp>,
    pub last_resume_time: Option<Timestamp>,
    pub max_concurrent_run_count: i64,
    pub allow_queueing: bool,
    pub catch_up: bool,
    pub last_scheduled_run_response: Option<RunResponse>,
    pub time_specification: Option<TimeSpecification>,
    pub request: Option<Request>,
    /* private fields */
}

An instance of a Schedule periodically schedules runs to make API calls based on user specified time specification and API request type.

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.

name: String

Immutable. The resource name of the Schedule.

display_name: String

Required. User provided name of the Schedule. The name can be up to 128 characters long and can consist of any UTF-8 characters.

start_time: Option<Timestamp>

Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified.

end_time: Option<Timestamp>

Optional. Timestamp after which no new runs can be scheduled. If specified, The schedule will be completed when either end_time is reached or when scheduled_run_count >= max_run_count. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.

max_run_count: i64

Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= max_run_count or when end_time is reached. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.

started_run_count: i64

Output only. The number of runs started by this schedule.

state: State

Output only. The state of this Schedule.

create_time: Option<Timestamp>

Output only. Timestamp when this Schedule was created.

update_time: Option<Timestamp>

Output only. Timestamp when this Schedule was updated.

next_run_time: Option<Timestamp>

Output only. Timestamp when this Schedule should schedule the next run. Having a next_run_time in the past means the runs are being started behind schedule.

last_pause_time: Option<Timestamp>

Output only. Timestamp when this Schedule was last paused. Unset if never paused.

last_resume_time: Option<Timestamp>

Output only. Timestamp when this Schedule was last resumed. Unset if never resumed from pause.

max_concurrent_run_count: i64

Required. Maximum number of runs that can be started concurrently for this Schedule. This is the limit for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable).

allow_queueing: bool

Optional. Whether new scheduled runs can be queued when max_concurrent_runs limit is reached. If set to true, new runs will be queued instead of skipped. Default to false.

catch_up: bool

Output only. Whether to backfill missed runs when the schedule is resumed from PAUSED state. If set to true, all missed runs will be scheduled. New runs will be scheduled after the backfill is complete. Default to false.

last_scheduled_run_response: Option<RunResponse>

Output only. Response of the last scheduled run. This is the response for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable). Unset if no run has been scheduled yet.

time_specification: Option<TimeSpecification>

Required. The time specification to launch scheduled runs.

request: Option<Request>

Required. The API request template to launch the scheduled runs. User-specified ID is not supported in the request template.

Implementations

impl Schedule

pub fn new() -> Self

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

Sets the value of name.

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

Sets the value of display_name.

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

Sets the value of start_time.

pub fn set_end_time<T: Into<Option<Timestamp>>>(self, v: T) -> Self

Sets the value of end_time.

pub fn set_max_run_count<T: Into<i64>>(self, v: T) -> Self

Sets the value of max_run_count.

pub fn set_started_run_count<T: Into<i64>>(self, v: T) -> Self

Sets the value of started_run_count.

pub fn set_state<T: Into<State>>(self, v: T) -> Self

Sets the value of state.

pub fn set_create_time<T: Into<Option<Timestamp>>>(self, v: T) -> Self

Sets the value of create_time.

pub fn set_update_time<T: Into<Option<Timestamp>>>(self, v: T) -> Self

Sets the value of update_time.

pub fn set_next_run_time<T: Into<Option<Timestamp>>>(self, v: T) -> Self

Sets the value of next_run_time.

pub fn set_last_pause_time<T: Into<Option<Timestamp>>>(self, v: T) -> Self

Sets the value of last_pause_time.

pub fn set_last_resume_time<T: Into<Option<Timestamp>>>(self, v: T) -> Self

Sets the value of last_resume_time.

pub fn set_max_concurrent_run_count<T: Into<i64>>(self, v: T) -> Self

Sets the value of max_concurrent_run_count.

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

Sets the value of allow_queueing.

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

Sets the value of catch_up.

pub fn set_last_scheduled_run_response<T: Into<Option<RunResponse>>>( self, v: T, ) -> Self

Sets the value of last_scheduled_run_response.

pub fn set_time_specification<T: Into<Option<TimeSpecification>>>( self, v: T, ) -> Self

Sets the value of time_specification.

Note that all the setters affecting time_specification are mutually exclusive.

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

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

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

Sets the value of time_specification to hold a Cron.

Note that all the setters affecting time_specification are mutually exclusive.

pub fn set_request<T: Into<Option<Request>>>(self, v: T) -> Self

Sets the value of request.

Note that all the setters affecting request are mutually exclusive.

pub fn create_pipeline_job_request( &self, ) -> Option<&Box<CreatePipelineJobRequest>>

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

pub fn set_create_pipeline_job_request<T: Into<Box<CreatePipelineJobRequest>>>( self, v: T, ) -> Self

Sets the value of request to hold a CreatePipelineJobRequest.

Note that all the setters affecting request are mutually exclusive.

pub fn create_notebook_execution_job_request( &self, ) -> Option<&Box<CreateNotebookExecutionJobRequest>>

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

pub fn set_create_notebook_execution_job_request<T: Into<Box<CreateNotebookExecutionJobRequest>>>( self, v: T, ) -> Self

Sets the value of request to hold a CreateNotebookExecutionJobRequest.

Note that all the setters affecting request are mutually exclusive.

Trait Implementations

impl Clone for Schedule

fn clone(&self) -> Schedule

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Schedule

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

Formats the value using the given formatter.

impl Default for Schedule

fn default() -> Schedule

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Schedule

where Schedule: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for Schedule

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Schedule

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

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 Schedule