JobState class

Input properties used for looking up and filtering Job resources.

Constructors

JobState({Input<JobAppEngineHttpTarget?>? appEngineHttpTarget, Input<String?>? attemptDeadline, Input<String?>? deletionPolicy, Input<String?>? description, Input<JobHttpTarget?>? httpTarget, Input<String?>? name, Input<bool?>? paused, Input<String?>? project, Input<JobPubsubTarget?>? pubsubTarget, Input<String?>? region, Input<JobRetryConfig?>? retryConfig, Input<String?>? schedule, Input<String?>? state, Input<String?>? timeZone})
Creates a new JobState. appEngineHttpTarget App Engine HTTP target. attemptDeadline The deadline for job attempts. If the request handler does not respond by this deadline then the request is deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. description A human-readable description for the job. httpTarget HTTP target. name The name of the job. paused Sets the job to a paused state. Jobs default to being enabled when this property is not set. project The ID of the project in which the resource belongs. pubsubTarget Pub/Sub target region Region where the scheduler job resides. If it is not provided, this provider will use the provider default. retryConfig By default, if a job does not complete successfully, schedule Describes the schedule on which the job will be executed. state State of the job. timeZone Specifies the time zone to be used in interpreting schedule.
const
JobState.fromMap(Map<String, dynamic> map)
factory

Properties

appEngineHttpTarget → Input<JobAppEngineHttpTarget?>?
App Engine HTTP target. If the job providers a App Engine HTTP target the cron will send a request to the service instance Structure is documented below.
final
attemptDeadline → Input<String?>?
The deadline for job attempts. If the request handler does not respond by this deadline then the request is cancelled and the attempt is marked as a DEADLINE_EXCEEDED failure. The failed attempt can be viewed in execution logs. Cloud Scheduler will retry the job according to the RetryConfig. The allowed duration for this deadline is:
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
description → Input<String?>?
A human-readable description for the job. This string must not contain more than 500 characters.
final
hashCode → int
The hash code for this object.
no setterinherited
httpTarget → Input<JobHttpTarget?>?
HTTP target. If the job providers a httpTarget the cron will send a request to the targeted url Structure is documented below.
final
name → Input<String?>?
The name of the job.
final
paused → Input<bool?>?
Sets the job to a paused state. Jobs default to being enabled when this property is not set.
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
pubsubTarget → Input<JobPubsubTarget?>?
Pub/Sub target If the job providers a Pub/Sub target the cron will publish a message to the provided topic Structure is documented below.
final
region → Input<String?>?
Region where the scheduler job resides. If it is not provided, this provider will use the provider default.
final
retryConfig → Input<JobRetryConfig?>?
By default, if a job does not complete successfully, meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings Structure is documented below.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
schedule → Input<String?>?
Describes the schedule on which the job will be executed.
final
state → Input<String?>?
State of the job.
final
timeZone → Input<String?>?
Specifies the time zone to be used in interpreting schedule. The value of this field must be a time zone name from the tz database.
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