(::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=
defcron_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
defdescription()->::String
Returns
(::String) — A brief description of this environment.
#description=
defdescription=(value)->::String
Parameter
value (::String) — A brief description of this environment.
Returns
(::String) — A brief description of this environment.
#display_name
defdisplay_name()->::String
Returns
(::String) — Output only. Display name used for UI purposes.
Name can only contain alphanumeric characters, hyphens -,
and underscores _.
(::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=
deftime_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).
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# AI Platform Notebooks V1 API - Class Google::Cloud::Notebooks::V1::Schedule (v1.1.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.1.0 (latest)](/ruby/docs/reference/google-cloud-notebooks-v1/latest/Google-Cloud-Notebooks-V1-Schedule)\n- [1.0.1](/ruby/docs/reference/google-cloud-notebooks-v1/1.0.1/Google-Cloud-Notebooks-V1-Schedule)\n- [0.11.0](/ruby/docs/reference/google-cloud-notebooks-v1/0.11.0/Google-Cloud-Notebooks-V1-Schedule)\n- [0.10.0](/ruby/docs/reference/google-cloud-notebooks-v1/0.10.0/Google-Cloud-Notebooks-V1-Schedule)\n- [0.9.1](/ruby/docs/reference/google-cloud-notebooks-v1/0.9.1/Google-Cloud-Notebooks-V1-Schedule)\n- [0.8.2](/ruby/docs/reference/google-cloud-notebooks-v1/0.8.2/Google-Cloud-Notebooks-V1-Schedule)\n- [0.7.0](/ruby/docs/reference/google-cloud-notebooks-v1/0.7.0/Google-Cloud-Notebooks-V1-Schedule)\n- [0.6.1](/ruby/docs/reference/google-cloud-notebooks-v1/0.6.1/Google-Cloud-Notebooks-V1-Schedule)\n- [0.5.0](/ruby/docs/reference/google-cloud-notebooks-v1/0.5.0/Google-Cloud-Notebooks-V1-Schedule)\n- [0.4.2](/ruby/docs/reference/google-cloud-notebooks-v1/0.4.2/Google-Cloud-Notebooks-V1-Schedule)\n- [0.3.0](/ruby/docs/reference/google-cloud-notebooks-v1/0.3.0/Google-Cloud-Notebooks-V1-Schedule)\n- [0.2.1](/ruby/docs/reference/google-cloud-notebooks-v1/0.2.1/Google-Cloud-Notebooks-V1-Schedule)\n- [0.1.0](/ruby/docs/reference/google-cloud-notebooks-v1/0.1.0/Google-Cloud-Notebooks-V1-Schedule) \nReference documentation and code samples for the AI Platform Notebooks V1 API class Google::Cloud::Notebooks::V1::Schedule.\n\nThe definition of a schedule. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #create_time\n\n def create_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. Time the schedule was created.\n\n### #cron_schedule\n\n def cron_schedule() -\u003e ::String\n\n**Returns**\n\n- (::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\n\n### #cron_schedule=\n\n def cron_schedule=(value) -\u003e ::String\n\n**Parameter**\n\n- **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 \n**Returns**\n\n- (::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\n\n### #description\n\n def description() -\u003e ::String\n\n**Returns**\n\n- (::String) --- A brief description of this environment.\n\n### #description=\n\n def description=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- A brief description of this environment. \n**Returns**\n\n- (::String) --- A brief description of this environment.\n\n### #display_name\n\n def display_name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Output only. Display name used for UI purposes. Name can only contain alphanumeric characters, hyphens `-`, and underscores `_`.\n\n### #execution_template\n\n def execution_template() -\u003e ::Google::Cloud::Notebooks::V1::ExecutionTemplate\n\n**Returns**\n\n- ([::Google::Cloud::Notebooks::V1::ExecutionTemplate](./Google-Cloud-Notebooks-V1-ExecutionTemplate)) --- Notebook Execution Template corresponding to this schedule.\n\n### #execution_template=\n\n def execution_template=(value) -\u003e ::Google::Cloud::Notebooks::V1::ExecutionTemplate\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Notebooks::V1::ExecutionTemplate](./Google-Cloud-Notebooks-V1-ExecutionTemplate)) --- Notebook Execution Template corresponding to this schedule. \n**Returns**\n\n- ([::Google::Cloud::Notebooks::V1::ExecutionTemplate](./Google-Cloud-Notebooks-V1-ExecutionTemplate)) --- Notebook Execution Template corresponding to this schedule.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Output only. The name of this schedule. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`\n\n### #recent_executions\n\n def recent_executions() -\u003e ::Array\u003c::Google::Cloud::Notebooks::V1::Execution\u003e\n\n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::Notebooks::V1::Execution](./Google-Cloud-Notebooks-V1-Execution)\\\u003e) --- Output only. The most recent execution names triggered from this schedule and their corresponding states.\n\n### #state\n\n def state() -\u003e ::Google::Cloud::Notebooks::V1::Schedule::State\n\n**Returns**\n\n- ([::Google::Cloud::Notebooks::V1::Schedule::State](./Google-Cloud-Notebooks-V1-Schedule-State))\n\n### #state=\n\n def state=(value) -\u003e ::Google::Cloud::Notebooks::V1::Schedule::State\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Notebooks::V1::Schedule::State](./Google-Cloud-Notebooks-V1-Schedule-State)) \n**Returns**\n\n- ([::Google::Cloud::Notebooks::V1::Schedule::State](./Google-Cloud-Notebooks-V1-Schedule-State))\n\n### #time_zone\n\n def time_zone() -\u003e ::String\n\n**Returns**\n\n- (::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\n\n Note that some time zones include a provision for daylight savings time.\n The rules for daylight saving time are determined by the chosen tz.\n For UTC use the string \"utc\". If a time zone is not specified,\n the default will be in UTC (also known as GMT).\n\n### #time_zone=\n\n def time_zone=(value) -\u003e ::String\n\n**Parameter**\n\n- **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\n\n\n Note that some time zones include a provision for daylight savings time.\n The rules for daylight saving time are determined by the chosen tz.\n For UTC use the string \"utc\". If a time zone is not specified,\nthe default will be in UTC (also known as GMT). \n**Returns**\n\n- (::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\n\n Note that some time zones include a provision for daylight savings time.\n The rules for daylight saving time are determined by the chosen tz.\n For UTC use the string \"utc\". If a time zone is not specified,\n the default will be in UTC (also known as GMT).\n\n### #update_time\n\n def update_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. Time the schedule was last updated."]]