Struct GoogleCloudAiplatformV1Schedule

pub struct GoogleCloudAiplatformV1Schedule {

    pub state: Option<String>,
    pub create_time: Option<DateTime<Utc>>,
    pub last_scheduled_run_response: Option<GoogleCloudAiplatformV1ScheduleRunResponse>,
    pub max_concurrent_run_count: Option<i64>,
    pub allow_queueing: Option<bool>,
    pub name: Option<String>,
    pub max_run_count: Option<i64>,
    pub update_time: Option<DateTime<Utc>>,
    pub next_run_time: Option<DateTime<Utc>>,
    pub cron: Option<String>,
    pub catch_up: Option<bool>,
    pub end_time: Option<DateTime<Utc>>,
    pub last_pause_time: Option<DateTime<Utc>>,
    pub create_pipeline_job_request: Option<GoogleCloudAiplatformV1CreatePipelineJobRequest>,
    pub started_run_count: Option<i64>,
    pub display_name: Option<String>,
    pub start_time: Option<DateTime<Utc>>,
    pub last_resume_time: Option<DateTime<Utc>>,
}

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

Activities

This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).

• locations schedules create projects (request|response)
• locations schedules get projects (response)
• locations schedules patch projects (request|response)

Fields

state: Option<String>

Output only. The state of this Schedule.

create_time: Option<DateTime<Utc>>

Output only. Timestamp when this Schedule was created.

last_scheduled_run_response: Option<GoogleCloudAiplatformV1ScheduleRunResponse>

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.

max_concurrent_run_count: Option<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: Option<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.

name: Option<String>

Immutable. The resource name of the Schedule.

max_run_count: Option<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.

update_time: Option<DateTime<Utc>>

Output only. Timestamp when this Schedule was updated.

next_run_time: Option<DateTime<Utc>>

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.

cron: Option<String>

Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: “CRON_TZ=${IANA_TIME_ZONE}” or “TZ=${IANA_TIME_ZONE}”. The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, “CRON_TZ=America/New_York 1 * * * *”, or “TZ=America/New_York 1 * * * *”.

catch_up: Option<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.

end_time: Option<DateTime<Utc>>

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.

last_pause_time: Option<DateTime<Utc>>

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

create_pipeline_job_request: Option<GoogleCloudAiplatformV1CreatePipelineJobRequest>

Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}).

started_run_count: Option<i64>

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

display_name: Option<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<DateTime<Utc>>

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

last_resume_time: Option<DateTime<Utc>>

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

Trait Implementations

impl Clone for GoogleCloudAiplatformV1Schedule

fn clone(&self) -> GoogleCloudAiplatformV1Schedule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GoogleCloudAiplatformV1Schedule

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

Formats the value using the given formatter.

impl Default for GoogleCloudAiplatformV1Schedule

fn default() -> GoogleCloudAiplatformV1Schedule

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GoogleCloudAiplatformV1Schedule

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for GoogleCloudAiplatformV1Schedule

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl RequestValue for GoogleCloudAiplatformV1Schedule

impl ResponseResult for GoogleCloudAiplatformV1Schedule