Reference documentation and code samples for the Google Cloud Notebooks V1 Client class Schedule.
The definition of a schedule.
Generated from protobuf message google.cloud.notebooks.v1.Schedule
Namespace
Google \ Cloud \ Notebooks \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. The name of this schedule. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}
↳ display_name
string
Output only. Display name used for UI purposes. Name can only contain alphanumeric characters, hyphens -
, and underscores _
.
↳ description
string
A brief description of this environment.
↳ state
int
↳ cron_schedule
string
Cron-tab formatted schedule by which the job will execute. Format: minute, hour, day of month, month, day of week, e.g. 0 0 * * WED
= every Wednesday More examples: https://crontab.guru/examples.html
↳ time_zone
string
Timezone on which the cron_schedule. The value of this field must be a time zone name from the tz database. TZ Database: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string "utc". If a time zone is not specified, the default will be in UTC (also known as GMT).
↳ create_time
↳ update_time
↳ execution_template
↳ recent_executions
array< Execution
>
Output only. The most recent execution names triggered from this schedule and their corresponding states.
getName
Output only. The name of this schedule. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}
string
setName
Output only. The name of this schedule. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}
var
string
$this
getDisplayName
Output only. Display name used for UI purposes.
Name can only contain alphanumeric characters, hyphens -
,
and underscores _
.
string
setDisplayName
Output only. Display name used for UI purposes.
Name can only contain alphanumeric characters, hyphens -
,
and underscores _
.
var
string
$this
getDescription
A brief description of this environment.
string
setDescription
A brief description of this environment.
var
string
$this
getState
Generated from protobuf field .google.cloud.notebooks.v1.Schedule.State state = 4;
int
setState
Generated from protobuf field .google.cloud.notebooks.v1.Schedule.State state = 4;
var
int
$this
getCronSchedule
Cron-tab formatted schedule by which the job will execute.
Format: minute, hour, day of month, month, day of week,
e.g. 0 0 * * WED
= every Wednesday
More examples: https://crontab.guru/examples.html
string
setCronSchedule
Cron-tab formatted schedule by which the job will execute.
Format: minute, hour, day of month, month, day of week,
e.g. 0 0 * * WED
= every Wednesday
More examples: https://crontab.guru/examples.html
var
string
$this
getTimeZone
Timezone on which the cron_schedule.
The value of this field must be a time zone name from the tz database. TZ Database: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string "utc". If a time zone is not specified, the default will be in UTC (also known as GMT).
string
setTimeZone
Timezone on which the cron_schedule.
The value of this field must be a time zone name from the tz database. TZ Database: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string "utc". If a time zone is not specified, the default will be in UTC (also known as GMT).
var
string
$this
getCreateTime
Output only. Time the schedule was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Time the schedule was created.
$this
getUpdateTime
Output only. Time the schedule was last updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Time the schedule was last updated.
$this
getExecutionTemplate
Notebook Execution Template corresponding to this schedule.
hasExecutionTemplate
clearExecutionTemplate
setExecutionTemplate
Notebook Execution Template corresponding to this schedule.
$this
getRecentExecutions
Output only. The most recent execution names triggered from this schedule and their corresponding states.
setRecentExecutions
Output only. The most recent execution names triggered from this schedule and their corresponding states.
$this
