- 1.63.0 (latest)
- 1.62.0
- 1.60.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.1
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.39.0
- 1.38.1
- 1.37.0
- 1.36.4
- 1.35.0
- 1.34.0
- 1.33.1
- 1.32.0
- 1.31.1
- 1.30.1
- 1.29.0
- 1.28.1
- 1.27.1
- 1.26.1
- 1.25.0
- 1.24.1
- 1.23.0
- 1.22.1
- 1.21.0
- 1.20.0
- 1.19.1
- 1.18.3
- 1.17.1
- 1.16.1
- 1.15.1
- 1.14.0
- 1.13.1
- 1.12.1
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.1
- 1.7.1
- 1.6.2
- 1.5.0
- 1.4.3
- 1.3.0
- 1.2.0
- 1.1.1
- 1.0.1
- 0.9.0
- 0.8.0
- 0.7.1
- 0.6.0
- 0.5.1
- 0.4.0
- 0.3.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.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _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 .
|
create_model_monitoring_job_request |
google.cloud.aiplatform_v1beta1.types.CreateModelMonitoringJobRequest
Request for ModelMonitoringService.CreateModelMonitoringJob. This field is a member of oneof _ request .
|
create_notebook_execution_job_request |
google.cloud.aiplatform_v1beta1.types.CreateNotebookExecutionJobRequest
Request for NotebookService.CreateNotebookExecutionJob. This field is a member of oneof _ request .
|
name |
str
Immutable. 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. |
Classes
RunResponse
RunResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Status of a scheduled run.
State
State(value)
Possible state of the schedule.
Methods
Schedule
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.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields