JobState class

Input properties used for looking up and filtering Job resources.

Constructors

JobState({Input<Map<String, String>?>? annotations, Input<JobBinaryAuthorization?>? binaryAuthorization, Input<String?>? client, Input<String?>? clientVersion, Input<List<JobCondition>?>? conditions, Input<String?>? createTime, Input<String?>? creator, Input<String?>? deleteTime, Input<String?>? deletionPolicy, Input<bool?>? deletionProtection, Input<Map<String, String>?>? effectiveAnnotations, Input<Map<String, String>?>? effectiveLabels, Input<String?>? etag, Input<int?>? executionCount, Input<String?>? expireTime, Input<String?>? generation, Input<Map<String, String>?>? labels, Input<String?>? lastModifier, Input<List<JobLatestCreatedExecution>?>? latestCreatedExecutions, Input<String?>? launchStage, Input<String?>? location, Input<String?>? name, Input<String?>? observedGeneration, Input<String?>? project, Input<Map<String, String>?>? pulumiLabels, Input<bool?>? reconciling, Input<String?>? runExecutionToken, Input<String?>? startExecutionToken, Input<Map<String, String>?>? tags, Input<JobTemplate?>? template, Input<List<JobTerminalCondition>?>? terminalConditions, Input<String?>? uid, Input<String?>? updateTime})
Creates a new JobState. annotations Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. binaryAuthorization Settings for the Binary Authorization feature. client Arbitrary identifier for the API client. clientVersion Arbitrary version identifier for the API client. conditions The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Job does not reach its desired state. See comments in reconciling for additional information on reconciliation process in Cloud Run. createTime (Output) creator Email address of the authenticated creator. deleteTime The deletion time. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. deletionProtection Whether Terraform will be prevented from destroying the job. Defaults to true. effectiveAnnotations All of annotations (key/value pairs) present on the resource in GCP, including the annotations configured through Terraform, other clients and services. effectiveLabels All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. etag A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. executionCount Number of executions created for this job. expireTime For a deleted resource, the time after which it will be permanently deleted. generation A number that monotonically increases every time the user modifies the desired state. labels Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, lastModifier Email address of the last authenticated modifier. latestCreatedExecutions Name of the last created execution. launchStage The launch stage as defined by Google Cloud Platform Launch Stages. Cloud Run supports ALPHA, BETA, and GA. location The location of the cloud run job name Name of the Job. observedGeneration The generation of this Job. See comments in reconciling for additional information on reconciliation process in Cloud Run. project The ID of the project in which the resource belongs. pulumiLabels The combination of labels configured directly on the resource reconciling Returns true if the Job is currently being acted upon by the system to bring it into the desired state. runExecutionToken A unique string used as a suffix creating a new execution upon job create or update. The Job will become ready when the execution is successfully completed. startExecutionToken A unique string used as a suffix creating a new execution upon job create or update. The Job will become ready when the execution is successfully started. tags A map of resource manager tags. template The template used to create executions for this Job. terminalConditions The Condition of this Job, containing its readiness status, and detailed error information in case it did not reach the desired state uid Server assigned unique identifier for the Execution. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. updateTime The last-modified time.
const
JobState.fromMap(Map<String, dynamic> map)
factory

Properties

annotations → Input<Map<String, String>?>?
Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected on new resources. All system annotations in v1 now have a corresponding field in v2 Job. This field follows Kubernetes annotations' namespacing, limits, and rules. Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effectiveAnnotations for all of the annotations present on the resource.
final
binaryAuthorization → Input<JobBinaryAuthorization?>?
Settings for the Binary Authorization feature. Structure is documented below.
final
client → Input<String?>?
Arbitrary identifier for the API client.
final
clientVersion → Input<String?>?
Arbitrary version identifier for the API client.
final
conditions → Input<List<JobCondition>?>?
The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Job does not reach its desired state. See comments in reconciling for additional information on reconciliation process in Cloud Run. Structure is documented below.
final
createTime → Input<String?>?
(Output) Creation timestamp of the execution. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
final
creator → Input<String?>?
Email address of the authenticated creator.
final
deleteTime → Input<String?>?
The deletion time.
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
deletionProtection → Input<bool?>?
Whether Terraform will be prevented from destroying the job. Defaults to true. When aterraform destroy or pulumi up would delete the job, the command will fail if this field is not set to false in Terraform state. When the field is set to true or unset in Terraform state, a pulumi up or terraform destroy that would delete the job will fail. When the field is set to false, deleting the job is allowed.
final
effectiveAnnotations → Input<Map<String, String>?>?
All of annotations (key/value pairs) present on the resource in GCP, including the annotations configured through Terraform, other clients and services.
final
effectiveLabels → Input<Map<String, String>?>?
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
final
etag → Input<String?>?
A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
final
executionCount → Input<int?>?
Number of executions created for this job.
final
expireTime → Input<String?>?
For a deleted resource, the time after which it will be permanently deleted.
final
generation → Input<String?>?
A number that monotonically increases every time the user modifies the desired state.
final
hashCode → int
The hash code for this object.
no setterinherited
labels → Input<Map<String, String>?>?
Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://docs.cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 Job. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.
final
lastModifier → Input<String?>?
Email address of the last authenticated modifier.
final
latestCreatedExecutions → Input<List<JobLatestCreatedExecution>?>?
Name of the last created execution. Structure is documented below.
final
launchStage → Input<String?>?
The launch stage as defined by Google Cloud Platform Launch Stages. Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output. Possible values are: UNIMPLEMENTED, PRELAUNCH, EARLY_ACCESS, ALPHA, BETA, GA, DEPRECATED.
final
location → Input<String?>?
The location of the cloud run job
final
name → Input<String?>?
Name of the Job.
final
observedGeneration → Input<String?>?
The generation of this Job. See comments in reconciling for additional information on reconciliation process in Cloud Run.
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
pulumiLabels → Input<Map<String, String>?>?
The combination of labels configured directly on the resource and default labels configured on the provider.
final
reconciling → Input<bool?>?
Returns true if the Job is currently being acted upon by the system to bring it into the desired state. When a new Job is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Job to the desired state. This process is called reconciliation. While reconciliation is in process, observedGeneration and latest_succeeded_execution, will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the state matches the Job, or there was an error, and reconciliation failed. This state can be found in terminalCondition.state. If reconciliation succeeded, the following fields will match: observedGeneration and generation, latestSucceededExecution and latestCreatedExecution. If reconciliation failed, observedGeneration and latestSucceededExecution will have the state of the last succeeded execution or empty for newly created Job. Additional information on the failure can be found in terminalCondition and conditions
final
runExecutionToken → Input<String?>?
A unique string used as a suffix creating a new execution upon job create or update. The Job will become ready when the execution is successfully completed. The sum of job name and token length must be fewer than 63 characters.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
startExecutionToken → Input<String?>?
A unique string used as a suffix creating a new execution upon job create or update. The Job will become ready when the execution is successfully started. The sum of job name and token length must be fewer than 63 characters.
final
tags → Input<Map<String, String>?>?
A map of resource manager tags. Resource manager tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/{tag_value_id}.
final
template → Input<JobTemplate?>?
The template used to create executions for this Job. Structure is documented below.
final
terminalConditions → Input<List<JobTerminalCondition>?>?
The Condition of this Job, containing its readiness status, and detailed error information in case it did not reach the desired state Structure is documented below.
final
uid → Input<String?>?
Server assigned unique identifier for the Execution. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
final
updateTime → Input<String?>?
The last-modified time.
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