AI Platform Notebooks V1 API - Class Google::Cloud::Notebooks::V1::Schedule (v0.1.0)

Reference documentation and code samples for the AI Platform Notebooks V1 API class Google::Cloud::Notebooks::V1::Schedule.

The definition of a schedule.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#cron_schedule

def cron_schedule() -> ::String
Returns
  • (::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

#cron_schedule=

def cron_schedule=(value) -> ::String
Parameter
  • value (::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
Returns
  • (::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

#description

def description() -> ::String
Returns
  • (::String) — A brief description of this environment.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — A brief description of this environment.
Returns
  • (::String) — A brief description of this environment.

#display_name

def display_name() -> ::String
Returns
  • (::String) — Output only. Display name used for UI purposes. Name can only contain alphanumeric characters, hyphens '-', and underscores '_'.

#execution_template

def execution_template() -> ::Google::Cloud::Notebooks::V1::ExecutionTemplate
Returns

#execution_template=

def execution_template=(value) -> ::Google::Cloud::Notebooks::V1::ExecutionTemplate
Parameter
Returns

#name

def name() -> ::String
Returns
  • (::String) — Output only. The name of this schedule. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}

#recent_executions

def recent_executions() -> ::Array<::Google::Cloud::Notebooks::V1::Execution>
Returns

#state

def state() -> ::Google::Cloud::Notebooks::V1::Schedule::State
Returns

#state=

def state=(value) -> ::Google::Cloud::Notebooks::V1::Schedule::State
Parameter
Returns

#time_zone

def time_zone() -> ::String
Returns
  • (::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).

#time_zone=

def time_zone=(value) -> ::String
Parameter
  • value (::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).

Returns
  • (::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).

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns