- 1.35.0 (latest)
- 1.34.0
- 1.33.0
- 1.32.1
- 1.31.0
- 1.30.0
- 1.26.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.1
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
- 0.39.0
- 0.38.0
- 0.37.1
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.2
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.13.0
- 0.12.0
- 0.11.1
- 0.10.0
Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class Schedule.
An instance of a Schedule periodically schedules runs to make API calls based on user specified time specification and API request type.
Generated from protobuf message google.cloud.aiplatform.v1.Schedule
Namespace
Google \ Cloud \ AIPlatform \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ cron
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 * * * *".
↳ create_pipeline_job_request
Google\Cloud\AIPlatform\V1\CreatePipelineJobRequest
Request for PipelineService.CreatePipelineJob . CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}).
↳ create_notebook_execution_job_request
↳ 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
Google\Protobuf\Timestamp
Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified.
↳ end_time
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.
↳ max_run_count
int|string
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|string
Output only. The number of runs started by this schedule.
↳ state
int
Output only. The state of this Schedule.
↳ create_time
↳ update_time
↳ next_run_time
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.
↳ last_pause_time
Google\Protobuf\Timestamp
Output only. Timestamp when this Schedule was last paused. Unset if never paused.
↳ last_resume_time
Google\Protobuf\Timestamp
Output only. Timestamp when this Schedule was last resumed. Unset if never resumed from pause.
↳ max_concurrent_run_count
int|string
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\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.
getCron
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 * * * *".
string
hasCron
setCron
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 * * * *".
var
string
$this
getCreatePipelineJobRequest
Request for PipelineService.CreatePipelineJob .
CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}).
hasCreatePipelineJobRequest
setCreatePipelineJobRequest
Request for PipelineService.CreatePipelineJob .
CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}).
$this
getCreateNotebookExecutionJobRequest
Request for NotebookService.CreateNotebookExecutionJob .
hasCreateNotebookExecutionJobRequest
setCreateNotebookExecutionJobRequest
Request for NotebookService.CreateNotebookExecutionJob .
$this
getName
Immutable. The resource name of the Schedule.
string
setName
Immutable. The resource name of the Schedule.
var
string
$this
getDisplayName
Required. User provided name of the Schedule.
The name can be up to 128 characters long and can consist of any UTF-8 characters.
string
setDisplayName
Required. User provided name of the Schedule.
The name can be up to 128 characters long and can consist of any UTF-8 characters.
var
string
$this
getStartTime
Optional. Timestamp after which the first run can be scheduled.
Default to Schedule create time if not specified.
hasStartTime
clearStartTime
setStartTime
Optional. Timestamp after which the first run can be scheduled.
Default to Schedule create time if not specified.
$this
getEndTime
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.
hasEndTime
clearEndTime
setEndTime
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.
$this
getMaxRunCount
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.
int|string
setMaxRunCount
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.
var
int|string
$this
getStartedRunCount
Output only. The number of runs started by this schedule.
int|string
setStartedRunCount
Output only. The number of runs started by this schedule.
var
int|string
$this
getState
Output only. The state of this Schedule.
int
setState
Output only. The state of this Schedule.
var
int
$this
getCreateTime
Output only. Timestamp when this Schedule was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp when this Schedule was created.
$this
getUpdateTime
Output only. Timestamp when this Schedule was updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Timestamp when this Schedule was updated.
$this
getNextRunTime
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.
hasNextRunTime
clearNextRunTime
setNextRunTime
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.
$this
getLastPauseTime
Output only. Timestamp when this Schedule was last paused.
Unset if never paused.
hasLastPauseTime
clearLastPauseTime
setLastPauseTime
Output only. Timestamp when this Schedule was last paused.
Unset if never paused.
$this
getLastResumeTime
Output only. Timestamp when this Schedule was last resumed.
Unset if never resumed from pause.
hasLastResumeTime
clearLastResumeTime
setLastResumeTime
Output only. Timestamp when this Schedule was last resumed.
Unset if never resumed from pause.
$this
getMaxConcurrentRunCount
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).
int|string
setMaxConcurrentRunCount
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).
var
int|string
$this
getAllowQueueing
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.
bool
setAllowQueueing
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.
var
bool
$this
getCatchUp
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.
bool
setCatchUp
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.
var
bool
$this
getLastScheduledRunResponse
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.
hasLastScheduledRunResponse
clearLastScheduledRunResponse
setLastScheduledRunResponse
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.
$this
getTimeSpecification
string
getRequest
string
