Google Cloud Ai Platform V1 Client - Class Schedule (1.4.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 \ V1

Methods

__construct

Constructor.

Parameters
Name Description
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 Google\Cloud\AIPlatform\V1\CreateNotebookExecutionJobRequest

Request for NotebookService.CreateNotebookExecutionJob.
↳ 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 Google\Protobuf\Timestamp

Output only. Timestamp when this Schedule was created.
↳ update_time Google\Protobuf\Timestamp

Output only. Timestamp when this Schedule was updated.
↳ 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 * * * *".

Returns
Type Description
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 * * * *".

Parameter
Name Description
var string
Returns
Type Description
$this

getCreatePipelineJobRequest

Request for PipelineService.CreatePipelineJob.

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

Returns
Type Description
Google\Cloud\AIPlatform\V1\CreatePipelineJobRequest|null

hasCreatePipelineJobRequest

setCreatePipelineJobRequest

Request for PipelineService.CreatePipelineJob.

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

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\CreatePipelineJobRequest
Returns
Type Description
$this

getCreateNotebookExecutionJobRequest

Request for NotebookService.CreateNotebookExecutionJob.

Returns
Type Description
Google\Cloud\AIPlatform\V1\CreateNotebookExecutionJobRequest|null

hasCreateNotebookExecutionJobRequest

setCreateNotebookExecutionJobRequest

Request for NotebookService.CreateNotebookExecutionJob.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\CreateNotebookExecutionJobRequest
Returns
Type Description
$this

getName

Immutable. The resource name of the Schedule.

Returns
Type Description
string

setName

Immutable. The resource name of the Schedule.

Parameter
Name Description
var string
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var string
Returns
Type Description
$this

getStartTime

Optional. Timestamp after which the first run can be scheduled.

Default to Schedule create time if not specified.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

Optional. Timestamp after which the first run can be scheduled.

Default to Schedule create time if not specified.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$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.

Returns
Type Description
Google\Protobuf\Timestamp|null

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.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getStartedRunCount

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

Returns
Type Description
int|string

setStartedRunCount

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

Parameter
Name Description
var int|string
Returns
Type Description
$this

getState

Output only. The state of this Schedule.

Returns
Type Description
int

setState

Output only. The state of this Schedule.

Parameter
Name Description
var int
Returns
Type Description
$this

getCreateTime

Output only. Timestamp when this Schedule was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp when this Schedule was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. Timestamp when this Schedule was updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Timestamp when this Schedule was updated.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$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.

Returns
Type Description
Google\Protobuf\Timestamp|null

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.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getLastPauseTime

Output only. Timestamp when this Schedule was last paused.

Unset if never paused.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasLastPauseTime

clearLastPauseTime

setLastPauseTime

Output only. Timestamp when this Schedule was last paused.

Unset if never paused.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getLastResumeTime

Output only. Timestamp when this Schedule was last resumed.

Unset if never resumed from pause.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasLastResumeTime

clearLastResumeTime

setLastResumeTime

Output only. Timestamp when this Schedule was last resumed.

Unset if never resumed from pause.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$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).

Returns
Type Description
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).

Parameter
Name Description
var int|string
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var bool
Returns
Type Description
$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.

Returns
Type Description
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.

Parameter
Name Description
var bool
Returns
Type Description
$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.

Returns
Type Description
Google\Cloud\AIPlatform\V1\Schedule\RunResponse|null

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.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\Schedule\RunResponse
Returns
Type Description
$this

getTimeSpecification

Returns
Type Description
string

getRequest

Returns
Type Description
string