Google Cloud Notebooks V1 Client - Class Schedule (1.0.0-RC1)

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 \ V1

Methods

__construct

Constructor.

Parameters
Name Description
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 Google\Protobuf\Timestamp

Output only. Time the schedule was created.
↳ update_time Google\Protobuf\Timestamp

Output only. Time the schedule was last updated.
↳ execution_template Google\Cloud\Notebooks\V1\ExecutionTemplate

Notebook Execution Template corresponding to this schedule.
↳ recent_executions array<Google\Cloud\Notebooks\V1\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}

Returns
Type Description
string

setName

Output only. The name of this schedule. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

Output only. Display name used for UI purposes.

Name can only contain alphanumeric characters, hyphens -, and underscores _.

Returns
Type Description
string

setDisplayName

Output only. Display name used for UI purposes.

Name can only contain alphanumeric characters, hyphens -, and underscores _.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

A brief description of this environment.

Returns
Type Description
string

setDescription

A brief description of this environment.

Parameter
Name Description
var string
Returns
Type Description
$this

getState

Generated from protobuf field .google.cloud.notebooks.v1.Schedule.State state = 4;

Returns
Type Description
int

setState

Generated from protobuf field .google.cloud.notebooks.v1.Schedule.State state = 4;

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

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

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

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

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. Time the schedule was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Time the schedule was created.

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

getUpdateTime

Output only. Time the schedule was last updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Time the schedule was last updated.

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

getExecutionTemplate

Notebook Execution Template corresponding to this schedule.

Returns
Type Description
Google\Cloud\Notebooks\V1\ExecutionTemplate|null

hasExecutionTemplate

clearExecutionTemplate

setExecutionTemplate

Notebook Execution Template corresponding to this schedule.

Parameter
Name Description
var Google\Cloud\Notebooks\V1\ExecutionTemplate
Returns
Type Description
$this

getRecentExecutions

Output only. The most recent execution names triggered from this schedule and their corresponding states.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setRecentExecutions

Output only. The most recent execution names triggered from this schedule and their corresponding states.

Parameter
Name Description
var array<Google\Cloud\Notebooks\V1\Execution>
Returns
Type Description
$this