GetScheduleResult class

Result data returned by getSchedule.

Constructors

GetScheduleResult({required bool allowQueueing, required bool catchUp, required GoogleCloudAiplatformV1CreatePipelineJobRequestResponse createPipelineJobRequest, required String createTime, required String cron, required String displayName, required String endTime, required String lastPauseTime, required String lastResumeTime, required GoogleCloudAiplatformV1ScheduleRunResponseResponse lastScheduledRunResponse, required String maxConcurrentRunCount, required String maxRunCount, required String name, required String nextRunTime, required String startTime, required String startedRunCount, required String state, required String updateTime})
Creates a new GetScheduleResult. allowQueueing 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. 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. createPipelineJobRequest Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}). createTime Timestamp when this Schedule was created. cron 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 * * * *". displayName User provided name of the Schedule. The name can be up to 128 characters long and can consist of any UTF-8 characters. endTime 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. 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. lastScheduledRunResponse 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. 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 operations/jobs created by the requests (if applicable). maxRunCount 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. name Immutable. The resource name of the Schedule. nextRunTime 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. startTime Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified. startedRunCount The number of runs started by this schedule. state The state of this Schedule. updateTime Timestamp when this Schedule was updated.
const
GetScheduleResult.fromMap(Map<String, dynamic> map)
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
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
createPipelineJobRequest → GoogleCloudAiplatformV1CreatePipelineJobRequestResponse
Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}).
final
createTime → String
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
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 → String
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 → String
Timestamp when this Schedule was last paused. Unset if never paused.
final
lastResumeTime → String
Timestamp when this Schedule was last resumed. Unset if never resumed from pause.
final
lastScheduledRunResponse → GoogleCloudAiplatformV1ScheduleRunResponseResponse
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 → 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 operations/jobs created by the requests (if applicable).
final
maxRunCount → String
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 → String
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
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
startedRunCount → String
The number of runs started by this schedule.
final
startTime → String
Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified.
final
state → String
The state of this Schedule.
final
updateTime → 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