ScheduleArgs class

The set of arguments for Schedule. The set of arguments for Schedule.

Constructors

ScheduleArgs({Input<bool>? allowQueueing, Input<GoogleCloudAiplatformV1CreatePipelineJobRequest>? createPipelineJobRequest, Input<String>? cron, required Input<String> displayName, Input<String>? endTime, Input<String>? location, required Input<String> maxConcurrentRunCount, Input<String>? maxRunCount, Input<String>? name, Input<String>? project, Input<String>? startTime})
Creates a new ScheduleArgs. 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. createPipelineJobRequest Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}). 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. location Optional. 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. project Optional. startTime Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified.
const
ScheduleArgs.fromMap(Map<String, dynamic> map)
factory

Properties

allowQueueing → Input<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
createPipelineJobRequest → Input<GoogleCloudAiplatformV1CreatePipelineJobRequest>?
Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}).
final
cron → Input<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 → Input<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 → Input<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
location → Input<String>?
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 operations/jobs created by the requests (if applicable).
final
maxRunCount → Input<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 → Input<String>?
Immutable. The resource name of the Schedule.
final
project → Input<String>?
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
startTime → Input<String>?
Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified.
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