Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::Schedule (v0.31.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::Schedule.

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

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#allow_queueing

def allow_queueing() -> ::Boolean

Returns

(::Boolean) — 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.

#allow_queueing=

def allow_queueing=(value) -> ::Boolean

Parameter

value (::Boolean) — 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.

Returns

(::Boolean) — 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

def catch_up() -> ::Boolean

Returns

(::Boolean) — 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.

#create_pipeline_job_request

def create_pipeline_job_request() -> ::Google::Cloud::AIPlatform::V1::CreatePipelineJobRequest

Returns

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

#create_pipeline_job_request=

def create_pipeline_job_request=(value) -> ::Google::Cloud::AIPlatform::V1::CreatePipelineJobRequest

Parameter

value (::Google::Cloud::AIPlatform::V1::CreatePipelineJobRequest) — Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}).

Returns

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

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Timestamp when this Schedule was created.

#cron

def cron() -> ::String

Returns

(::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 * * * *".

#cron=

def cron=(value) -> ::String

Parameter

value (::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 * * * *".

Returns

(::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 * * * *".

#display_name

def display_name() -> ::String

Returns

(::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.

#display_name=

def display_name=(value) -> ::String

Parameter

value (::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.

Returns

(::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.

#end_time

def end_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::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.

#end_time=

def end_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

value (::Google::Protobuf::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.

Returns

(::Google::Protobuf::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.

#last_pause_time

def last_pause_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Timestamp when this Schedule was last paused. Unset if never paused.

#last_resume_time

def last_resume_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Timestamp when this Schedule was last resumed. Unset if never resumed from pause.

#last_scheduled_run_response

def last_scheduled_run_response() -> ::Google::Cloud::AIPlatform::V1::Schedule::RunResponse

Returns

(::Google::Cloud::AIPlatform::V1::Schedule::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.

#max_concurrent_run_count

def max_concurrent_run_count() -> ::Integer

Returns

(::Integer) — 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).

#max_concurrent_run_count=

def max_concurrent_run_count=(value) -> ::Integer

Parameter

value (::Integer) — 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).

Returns

(::Integer) — 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).

#max_run_count

def max_run_count() -> ::Integer

Returns

(::Integer) — 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.

#max_run_count=

def max_run_count=(value) -> ::Integer

Parameter

value (::Integer) — 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.

Returns

(::Integer) — 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.

#name

def name() -> ::String

Returns

(::String) — Immutable. The resource name of the Schedule.

#name=

def name=(value) -> ::String

Parameter

value (::String) — Immutable. The resource name of the Schedule.

Returns

(::String) — Immutable. The resource name of the Schedule.

#next_run_time

def next_run_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::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.

#start_time

def start_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified.

#start_time=

def start_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

value (::Google::Protobuf::Timestamp) — Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified.

Returns

(::Google::Protobuf::Timestamp) — Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified.

#started_run_count

def started_run_count() -> ::Integer

Returns

(::Integer) — Output only. The number of runs started by this schedule.

#state

def state() -> ::Google::Cloud::AIPlatform::V1::Schedule::State

Returns

(::Google::Cloud::AIPlatform::V1::Schedule::State) — Output only. The state of this Schedule.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Timestamp when this Schedule was updated.