Schedule class final

An instance of a Schedule periodically schedules runs to make API calls based on user specified time specification and API request type.

Inheritance
  • Object
  • ProtoMessage
  • Schedule

Constructors

Schedule({String? cron, CreatePipelineJobRequest? createPipelineJobRequest, CreateModelMonitoringJobRequest? createModelMonitoringJobRequest, CreateNotebookExecutionJobRequest? createNotebookExecutionJobRequest, String name = '', required String displayName, Timestamp? startTime, Timestamp? endTime, int maxRunCount = 0, int startedRunCount = 0, Schedule_State state = Schedule_State.$default, Timestamp? createTime, Timestamp? updateTime, Timestamp? nextRunTime, Timestamp? lastPauseTime, Timestamp? lastResumeTime, required int maxConcurrentRunCount, bool allowQueueing = false, bool catchUp = false, Schedule_RunResponse? lastScheduledRunResponse})
Schedule.fromJson(Object? j)
factory

Properties

allowQueueing → bool
Optional. Whether new scheduled runs can be queued when max_concurrent_runs limit is reached. If set to true, new runs will be queued instead of skipped. Default to false.
final
catchUp → bool
Output only. Whether to backfill missed runs when the schedule is resumed from PAUSED state. If set to true, all missed runs will be scheduled. New runs will be scheduled after the backfill is complete. Default to false.
final
createModelMonitoringJobRequest → CreateModelMonitoringJobRequest?
Request for ModelMonitoringService.CreateModelMonitoringJob.
final
createNotebookExecutionJobRequest → CreateNotebookExecutionJobRequest?
Request for NotebookService.CreateNotebookExecutionJob.
final
createPipelineJobRequest → CreatePipelineJobRequest?
Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}).
final
createTime → Timestamp?
Output only. Timestamp when this Schedule was created.
final
cron → String?
Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *".
final
displayName → String
Required. User provided name of the Schedule. The name can be up to 128 characters long and can consist of any UTF-8 characters.
final
endTime → Timestamp?
Optional. Timestamp after which no new runs can be scheduled. If specified, The schedule will be completed when either end_time is reached or when scheduled_run_count >= max_run_count. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.
final
hashCode → int
The hash code for this object.
no setterinherited
lastPauseTime → Timestamp?
Output only. Timestamp when this Schedule was last paused. Unset if never paused.
final
lastResumeTime → Timestamp?
Output only. Timestamp when this Schedule was last resumed. Unset if never resumed from pause.
final
lastScheduledRunResponse → Schedule_RunResponse?
Output only. Response of the last scheduled run. This is the response for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable). Unset if no run has been scheduled yet.
final
maxConcurrentRunCount → int
Required. Maximum number of runs that can be started concurrently for this Schedule. This is the limit for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable).
final
maxRunCount → int
Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= max_run_count or when end_time is reached. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.
final
name → String
Immutable. The resource name of the Schedule.
final
nextRunTime → Timestamp?
Output only. Timestamp when this Schedule should schedule the next run. Having a next_run_time in the past means the runs are being started behind schedule.
final
qualifiedName → String
The fully qualified name of this message, i.e., google.protobuf.Duration or google.rpc.ErrorInfo.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
startedRunCount → int
Output only. The number of runs started by this schedule.
final
startTime → Timestamp?
Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified.
final
state → Schedule_State
Output only. The state of this Schedule.
final
updateTime → Timestamp?
Output only. Timestamp when this Schedule was updated.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Object
override
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

fullyQualifiedName → const String