Struct google_api_proto::google::cloud::aiplatform::v1::Schedule

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: i32,
    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>,
}

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

Fields

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: i32

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 state(&self) -> State

Returns the enum value of state, or the default if the field is set to an invalid enum value.

pub fn set_state(&mut self, value: State)

Sets state to the provided enum value.

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() -> Self

Returns the “default value” for a type.

impl Message for Schedule

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 PartialEq for Schedule

fn eq(&self, other: &Schedule) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Schedule