ScheduleState class

Input properties used for looking up and filtering Schedule resources.

Constructors

ScheduleState({Input<bool?>? allowQueueing, Input<bool?>? catchUp, Input<ScheduleCreateNotebookExecutionJobRequest?>? createNotebookExecutionJobRequest, Input<ScheduleCreatePipelineJobRequest?>? createPipelineJobRequest, Input<String?>? createTime, Input<String?>? cron, Input<String?>? deletionPolicy, Input<String?>? desiredState, Input<String?>? displayName, Input<String?>? endTime, Input<String?>? lastPauseTime, Input<String?>? lastResumeTime, Input<List<ScheduleLastScheduledRunResponse>?>? lastScheduledRunResponses, Input<String?>? location, Input<String?>? maxConcurrentActiveRunCount, Input<String?>? maxConcurrentRunCount, Input<String?>? maxRunCount, Input<String?>? name, Input<String?>? nextRunTime, Input<String?>? project, Input<String?>? startTime, Input<String?>? startedRunCount, Input<String?>? state, Input<String?>? updateTime})
Creates a new ScheduleState. allowQueueing Whether new scheduled runs can be queued when maxConcurrentRuns limit is reached. If set to true, new runs will be queued instead of skipped. Default to false. catchUp 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. createNotebookExecutionJobRequest Request for google_colab_notebook_execution. createPipelineJobRequest Request message for PipelineService.CreatePipelineJob. createTime Timestamp when this Schedule was created. cron Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. desiredState Desired state of the Colab Schedule. Set this field to ACTIVE to start/resume the schedule, and PAUSED to pause the schedule. displayName Required. The display name of the Schedule. endTime Timestamp after which no new runs can be scheduled. If specified, the schedule will be completed when either endTime is reached or when scheduledRunCount >= max_run_count. Must be in the RFC 3339 (https://www.ietf.org/rfc/rfc3339.txt) format. lastPauseTime Timestamp when this Schedule was last paused. Unset if never paused. lastResumeTime Timestamp when this Schedule was last resumed. Unset if never resumed from pause. lastScheduledRunResponses Status of a scheduled run. location The location for the resource: https://cloud.google.com/colab/docs/locations maxConcurrentActiveRunCount Specifies the maximum number of active runs that can be executed concurrently for this Schedule. This limits the number of runs that can be in a non-terminal state at the same time. Currently, this field is only supported for requests of type CreatePipelineJobRequest. maxConcurrentRunCount 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 notebook execution jobs created by the requests. maxRunCount Maximum run count of the schedule. If specified, The schedule will be completed when either startedRunCount >= maxRunCount or when endTime 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. name The resource name of the Schedule nextRunTime Timestamp when this Schedule should schedule the next run. Having a nextRunTime in the past means the runs are being started behind schedule. project The ID of the project in which the resource belongs. startTime The timestamp after which the first run can be scheduled. Defaults to the schedule creation time. Must be in the RFC 3339 (https://www.ietf.org/rfc/rfc3339.txt) format. startedRunCount The number of runs started by this schedule. state Output only. The state of the schedule. updateTime Timestamp when this Schedule was updated.
const
ScheduleState.fromMap(Map<String, dynamic> map)
factory

Properties

allowQueueing → Input<bool?>?
Whether new scheduled runs can be queued when maxConcurrentRuns limit is reached. If set to true, new runs will be queued instead of skipped. Default to false.
final
catchUp → Input<bool?>?
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
createNotebookExecutionJobRequest → Input<ScheduleCreateNotebookExecutionJobRequest?>?
Request for google_colab_notebook_execution. Structure is documented below.
final
createPipelineJobRequest → Input<ScheduleCreatePipelineJobRequest?>?
Request message for PipelineService.CreatePipelineJob. Structure is documented below.
final
createTime → Input<String?>?
Timestamp when this Schedule was created.
final
cron → Input<String?>?
Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs.
final
deletionPolicy → Input<String?>?
Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
desiredState → Input<String?>?
Desired state of the Colab Schedule. Set this field to ACTIVE to start/resume the schedule, and PAUSED to pause the schedule.
final
displayName → Input<String?>?
Required. The display name of the Schedule.
final
endTime → Input<String?>?
Timestamp after which no new runs can be scheduled. If specified, the schedule will be completed when either endTime is reached or when scheduledRunCount >= max_run_count. Must be in the RFC 3339 (https://www.ietf.org/rfc/rfc3339.txt) format.
final
hashCode → int
The hash code for this object.
no setterinherited
lastPauseTime → Input<String?>?
Timestamp when this Schedule was last paused. Unset if never paused.
final
lastResumeTime → Input<String?>?
Timestamp when this Schedule was last resumed. Unset if never resumed from pause.
final
lastScheduledRunResponses → Input<List<ScheduleLastScheduledRunResponse>?>?
Status of a scheduled run. Structure is documented below.
final
location → Input<String?>?
The location for the resource: https://cloud.google.com/colab/docs/locations
final
maxConcurrentActiveRunCount → Input<String?>?
Specifies the maximum number of active runs that can be executed concurrently for this Schedule. This limits the number of runs that can be in a non-terminal state at the same time. Currently, this field is only supported for requests of type CreatePipelineJobRequest.
final
maxConcurrentRunCount → Input<String?>?
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 notebook execution jobs created by the requests.
final
maxRunCount → Input<String?>?
Maximum run count of the schedule. If specified, The schedule will be completed when either startedRunCount >= maxRunCount or when endTime 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 → Input<String?>?
The resource name of the Schedule
final
nextRunTime → Input<String?>?
Timestamp when this Schedule should schedule the next run. Having a nextRunTime in the past means the runs are being started behind schedule.
final
project → Input<String?>?
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
startedRunCount → Input<String?>?
The number of runs started by this schedule.
final
startTime → Input<String?>?
The timestamp after which the first run can be scheduled. Defaults to the schedule creation time. Must be in the RFC 3339 (https://www.ietf.org/rfc/rfc3339.txt) format.
final
state → Input<String?>?
Output only. The state of the schedule.
final
updateTime → Input<String?>?
Timestamp when this Schedule was updated.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

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