Class Schedule (1.9.0)

Schedule(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The definition of a schedule.


name str
Output only. The name of this schedule. Format: projects/{project_id}/locations/{location}/schedules/{schedule_id}
display_name str
Output only. Display name used for UI purposes. Name can only contain alphanumeric characters, hyphens -, and underscores _.
description str
A brief description of this environment.
cron_schedule str
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:
time_zone str
Timezone on which the cron_schedule. The value of this field must be a time zone name from the tz database. TZ Database: 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_pb2.Timestamp
Output only. Time the schedule was created.
update_time google.protobuf.timestamp_pb2.Timestamp
Output only. Time the schedule was last updated.
Notebook Execution Template corresponding to this schedule.
recent_executions MutableSequence[]
Output only. The most recent execution names triggered from this schedule and their corresponding states.




State of the job.

Values: STATE_UNSPECIFIED (0): Unspecified state. ENABLED (1): The job is executing normally. PAUSED (2): The job is paused by the user. It will not execute. A user can intentionally pause the job using [PauseJobRequest][]. DISABLED (3): The job is disabled by the system due to error. The user cannot directly set a job to be disabled. UPDATE_FAILED (4): The job state resulting from a failed [CloudScheduler.UpdateJob][] operation. To recover a job from this state, retry [CloudScheduler.UpdateJob][] until a successful response is received. INITIALIZING (5): The schedule resource is being created. DELETING (6): The schedule resource is being deleted.