AI Platform Notebooks v1 API - Class Schedule (2.3.0)

public sealed class Schedule : IMessage<Schedule>, IEquatable<Schedule>, IDeepCloneable<Schedule>, IBufferMessage, IMessage

Reference documentation and code samples for the AI Platform Notebooks v1 API class Schedule.

The definition of a schedule.

Inheritance

object > Schedule

Namespace

Google.Cloud.Notebooks.V1

Assembly

Google.Cloud.Notebooks.V1.dll

Constructors

Schedule()

public Schedule()

Schedule(Schedule)

public Schedule(Schedule other)
Parameter
NameDescription
otherSchedule

Properties

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Time the schedule was created.

Property Value
TypeDescription
Timestamp

CronSchedule

public string CronSchedule { get; set; }

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

Property Value
TypeDescription
string

Description

public string Description { get; set; }

A brief description of this environment.

Property Value
TypeDescription
string

DisplayName

public string DisplayName { get; set; }

Output only. Display name used for UI purposes. Name can only contain alphanumeric characters, hyphens -, and underscores _.

Property Value
TypeDescription
string

ExecutionTemplate

public ExecutionTemplate ExecutionTemplate { get; set; }

Notebook Execution Template corresponding to this schedule.

Property Value
TypeDescription
ExecutionTemplate

Name

public string Name { get; set; }

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

Property Value
TypeDescription
string

RecentExecutions

public RepeatedField<Execution> RecentExecutions { get; }

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

Property Value
TypeDescription
RepeatedFieldExecution

ScheduleName

public ScheduleName ScheduleName { get; set; }

ScheduleName-typed view over the Name resource name property.

Property Value
TypeDescription
ScheduleName

State

public Schedule.Types.State State { get; set; }
Property Value
TypeDescription
ScheduleTypesState

TimeZone

public string TimeZone { get; set; }

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).

Property Value
TypeDescription
string

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. Time the schedule was last updated.

Property Value
TypeDescription
Timestamp