Schedule class

Creates a Schedule.

Constructors

Schedule(String name, {ScheduleArgs? args, CustomResourceOptions? options})
Creates a new Schedule. name The Pulumi resource name. args Arguments used to configure this Schedule. The set of arguments for Schedule. options Resource options controlling this resource's behavior.

Properties

allowQueueing ↔ Output<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.
latefinal
catchUp ↔ Output<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.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
createPipelineJobRequest ↔ Output<GoogleCloudAiplatformV1CreatePipelineJobRequestResponse>
Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}).
latefinal
createTime ↔ Output<String>
Timestamp when this Schedule was created.
latefinal
cron ↔ Output<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 * * * *".
latefinal
displayName ↔ Output<String>
User provided name of the Schedule. The name can be up to 128 characters long and can consist of any UTF-8 characters.
latefinal
endTime ↔ Output<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.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
lastPauseTime ↔ Output<String>
Timestamp when this Schedule was last paused. Unset if never paused.
latefinal
lastResumeTime ↔ Output<String>
Timestamp when this Schedule was last resumed. Unset if never resumed from pause.
latefinal
lastScheduledRunResponse ↔ Output<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.
latefinal
location ↔ Output<String>
latefinal
maxConcurrentRunCount ↔ Output<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).
latefinal
maxRunCount ↔ Output<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.
latefinal
name ↔ Output<String>
Immutable. The resource name of the Schedule.
latefinal
nextRunTime ↔ Output<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.
latefinal
project ↔ Output<String>
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
startedRunCount ↔ Output<String>
The number of runs started by this schedule.
latefinal
startTime ↔ Output<String>
Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified.
latefinal
state ↔ Output<String>
The state of this Schedule.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
updateTime ↔ Output<String>
Timestamp when this Schedule was updated.
latefinal
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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