JobState class

Input properties used for looking up and filtering Job resources.

Constructors

JobState({Input<List<String>?>? additionalExperiments, Input<String?>? deletionPolicy, Input<Map<String, String>?>? effectiveLabels, Input<bool?>? enableStreamingEngine, Input<String?>? ipConfiguration, Input<String?>? jobId, Input<String?>? kmsKeyName, Input<Map<String, String>?>? labels, Input<String?>? machineType, Input<int?>? maxWorkers, Input<String?>? name, Input<String?>? network, Input<String?>? onDelete, Input<Map<String, String>?>? parameters, Input<String?>? project, Input<Map<String, String>?>? pulumiLabels, Input<String?>? region, Input<String?>? serviceAccountEmail, Input<bool?>? skipWaitOnJobTermination, Input<String?>? state, Input<String?>? subnetwork, Input<String?>? tempGcsLocation, Input<String?>? templateGcsPath, Input<Map<String, String>?>? transformNameMapping, Input<String?>? type, Input<String?>? zone})

Creates a new JobState. additionalExperiments List of experiments that should be used by the job. An example value is ["enableStackdriverAgentMetrics"]. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE". effectiveLabels All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. enableStreamingEngine Enable/disable the use of Streaming Engine for the job. Note that Streaming Engine is enabled by default for pipelines developed against the Beam SDK for Python v2.21.0 or later when using Python 3. ipConfiguration The configuration for VM IPs. Options are "WORKER_IP_PUBLIC" or "WORKER_IP_PRIVATE". jobId The unique ID of this job. kmsKeyName The name for the Cloud KMS key for the job. Key format is: projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY labels User labels to be specified for the job. Keys and values should follow the restrictions machineType The machine type to use for the job. maxWorkers The number of workers permitted to work on the job. More workers may improve processing speed at additional cost. name A unique name for the resource, required by Dataflow. network The network to which VMs will be assigned. If it is not provided, "default" will be used. onDelete One of "drain" or "cancel". Specifies behavior of deletion during pulumi destroy. See above note. parameters Template specific Key/Value pairs to be forwarded to the pipeline's options; keys are project The project in which the resource belongs. If it is not provided, the provider project is used. pulumiLabels The combination of labels configured directly on the resource and default labels configured on the provider. region The region in which the created job should run. serviceAccountEmail The Service Account email used to create the job. This should be just an email e.g. [e-mail]. Do not include any serviceAccount: or other prefix. skipWaitOnJobTermination If set to true, Pulumi will treat DRAINING and CANCELLING as terminal states when deleting the resource, and will remove the resource from Pulumi state and move on. See above note. state The current state of the resource, selected from the JobState enum subnetwork The subnetwork to which VMs will be assigned. Should be of the form "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is located in a Shared VPC network, you must use the complete URL. For example "googleapis.com/compute/v1/projects/PROJECT_ID/regions/REGION/subnetworks/SUBNET_NAME" tempGcsLocation A writeable location on GCS for the Dataflow job to dump its temporary data. templateGcsPath The GCS path to the Dataflow job template. transformNameMapping Only applicable when updating a pipeline. Map of transform name prefixes of the job to be replaced with the corresponding name prefixes of the new job. This field is not used outside of update. type The type of this job, selected from the JobType enum zone The zone in which the created job should run. If it is not provided, the provider zone is used.

const

JobState.fromMap(Map<String, dynamic> map)

factory

Properties

additionalExperiments → Input<List<String>?>?

List of experiments that should be used by the job. An example value is ["enableStackdriverAgentMetrics"].

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

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

enableStreamingEngine → Input<bool?>?

Enable/disable the use of Streaming Engine for the job. Note that Streaming Engine is enabled by default for pipelines developed against the Beam SDK for Python v2.21.0 or later when using Python 3.

final

hashCode → int

The hash code for this object.

no setter, inherited

ipConfiguration → Input<String?>?

The configuration for VM IPs. Options are "WORKER_IP_PUBLIC" or "WORKER_IP_PRIVATE".

final

jobId → Input<String?>?

The unique ID of this job.

final

kmsKeyName → Input<String?>?

The name for the Cloud KMS key for the job. Key format is: projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY

final

labels → Input<Map<String, String>?>?

User labels to be specified for the job. Keys and values should follow the restrictions specified in the labeling restrictions page. 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

machineType → Input<String?>?

The machine type to use for the job.

final

maxWorkers → Input<int?>?

The number of workers permitted to work on the job. More workers may improve processing speed at additional cost.

final

name → Input<String?>?

A unique name for the resource, required by Dataflow.

final

network → Input<String?>?

The network to which VMs will be assigned. If it is not provided, "default" will be used.

final

onDelete → Input<String?>?

One of "drain" or "cancel". Specifies behavior of deletion during pulumi destroy. See above note.

final

parameters → Input<Map<String, String>?>?

Template specific Key/Value pairs to be forwarded to the pipeline's options; keys are case-sensitive based on the language on which the pipeline is coded, mostly Java. Note: do not configure Dataflow options here in parameters.

final

project → Input<String?>?

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

region → Input<String?>?

The region in which the created job should run.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

serviceAccountEmail → Input<String?>?

The Service Account email used to create the job. This should be just an email e.g. [e-mail]. Do not include any serviceAccount: or other prefix.

final

skipWaitOnJobTermination → Input<bool?>?

If set to true, Pulumi will treat DRAINING and CANCELLING as terminal states when deleting the resource, and will remove the resource from Pulumi state and move on. See above note.

final

state → Input<String?>?

The current state of the resource, selected from the JobState enum

final

subnetwork → Input<String?>?

The subnetwork to which VMs will be assigned. Should be of the form "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is located in a Shared VPC network, you must use the complete URL. For example "googleapis.com/compute/v1/projects/PROJECT_ID/regions/REGION/subnetworks/SUBNET_NAME"

final

tempGcsLocation → Input<String?>?

A writeable location on GCS for the Dataflow job to dump its temporary data.

final

templateGcsPath → Input<String?>?

The GCS path to the Dataflow job template.

final

transformNameMapping → Input<Map<String, String>?>?

Only applicable when updating a pipeline. Map of transform name prefixes of the job to be replaced with the corresponding name prefixes of the new job. This field is not used outside of update.

final

type → Input<String?>?

The type of this job, selected from the JobType enum

final

zone → Input<String?>?

The zone in which the created job should run. If it is not provided, the provider zone is used.

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