Class Schedule (1.26.1)

  Schedule 
 ( 
 mapping 
 = 
 None 
 , 
 * 
 , 
 ignore_unknown_fields 
 = 
 False 
 , 
 ** 
 kwargs 
 )

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

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

Name

Description

cron

str
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 \* \* \* \*". This field is a member of oneof _ time_specification .

create_pipeline_job_request

 google.cloud.aiplatform_v1beta1.types.CreatePipelineJobRequest

Request for PipelineService.CreatePipelineJob . CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}). This field is a member of oneof _ request .

name

str
Output only. The resource name of the Schedule.

display_name

str
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

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

end_time

google.protobuf.timestamp_pb2.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

int
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

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

state

 google.cloud.aiplatform_v1beta1.types.Schedule.State

Output only. The state of this Schedule.

create_time

google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp when this Schedule was created.

update_time

google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp when this Schedule was updated.

next_run_time

google.protobuf.timestamp_pb2.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

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

last_resume_time

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

max_concurrent_run_count

int
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

 google.cloud.aiplatform_v1beta1.types.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.

Inheritance

builtins.object > proto.message.Message > Schedule

Classes

RunResponse

  RunResponse 
 ( 
 mapping 
 = 
 None 
 , 
 * 
 , 
 ignore_unknown_fields 
 = 
 False 
 , 
 ** 
 kwargs 
 )

Status of a scheduled run.

State

  State 
 ( 
 value 
 )

Possible state of the schedule.

Values: STATE_UNSPECIFIED (0): Unspecified. ACTIVE (1): The Schedule is active. Runs are being scheduled on the user-specified timespec. PAUSED (2): The schedule is paused. No new runs will be created until the schedule is resumed. Already started runs will be allowed to complete. COMPLETED (3): The Schedule is completed. No new runs will be scheduled. Already started runs will be allowed to complete. Schedules in completed state cannot be paused or resumed.