FlexTemplateJobState class

Input properties used for looking up and filtering FlexTemplateJob resources.

Constructors

FlexTemplateJobState({Input<List<String>?>? additionalExperiments, Input<List<String>?>? additionalPipelineOptions, Input<String?>? autoscalingAlgorithm, Input<String?>? containerSpecGcsPath, Input<bool?>? createIgnoreAlreadyExists, 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?>? launcherMachineType, Input<String?>? machineType, Input<int?>? maxWorkers, Input<String?>? name, Input<String?>? network, Input<int?>? numWorkers, Input<String?>? onDelete, Input<Map<String, String>?>? parameters, Input<String?>? project, Input<Map<String, String>?>? pulumiLabels, Input<String?>? region, Input<String?>? sdkContainerImage, Input<String?>? serviceAccountEmail, Input<bool?>? skipWaitOnJobTermination, Input<String?>? stagingLocation, Input<String?>? state, Input<String?>? subnetwork, Input<String?>? tempLocation, Input<Map<String, String>?>? transformNameMapping, Input<String?>? type})
Creates a new FlexTemplateJobState. additionalExperiments List of experiments that should be used by the job. An example value is ["enableStackdriverAgentMetrics"]. additionalPipelineOptions List of pipeline options that should be used by the job. An example value is ["numberOfWorkerHarnessThreads=20"]. autoscalingAlgorithm The algorithm to use for autoscaling. containerSpecGcsPath The GCS path to the Dataflow job Flex createIgnoreAlreadyExists If true, if a 409 AlreadyExists error is returned on create, the provider will ignore it and adopt the existing resource. 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 Immutable. Indicates if the job should use the streaming engine feature. 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 launcherMachineType The machine type to use for launching the job. The default is n1-standard-1. machineType The machine type to use for the job. maxWorkers Immutable. The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000. name Immutable. 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. numWorkers Immutable. The initial number of Google Compute Engine instances for the job. onDelete One of "drain" or "cancel". Specifies behavior of 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 pulumiLabels The combination of labels configured directly on the resource and default labels configured on the provider. region Immutable. The region in which the created job should run. sdkContainerImage Docker registry location of container image to use for the 'worker harness. Default is the container for the version of the SDK. Note this field is only valid for portable pipelines. serviceAccountEmail Service account email to run the workers as. This should be just an email e.g. myserviceaccount@myproject.iam.gserviceaccount.com. Do not include any serviceAccount: or other prefix. skipWaitOnJobTermination If set to true, terraform will stagingLocation The Cloud Storage path to use for staging files. Must be a valid Cloud Storage URL, beginning with gs://. 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". tempLocation The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with gs://. 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.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. type The type of this job, selected from the JobType enum.
const
FlexTemplateJobState.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
additionalPipelineOptions → Input<List<String>?>?
List of pipeline options that should be used by the job. An example value is ["numberOfWorkerHarnessThreads=20"].
final
autoscalingAlgorithm → Input<String?>?
The algorithm to use for autoscaling.
final
containerSpecGcsPath → Input<String?>?
The GCS path to the Dataflow job Flex Template.
final
createIgnoreAlreadyExists → Input<bool?>?
If true, if a 409 AlreadyExists error is returned on create, the provider will ignore it and adopt the existing resource.
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?>?
Immutable. Indicates if the job should use the streaming engine feature.
final
hashCode → int
The hash code for this object.
no setterinherited
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
launcherMachineType → Input<String?>?
The machine type to use for launching the job. The default is n1-standard-1.
final
machineType → Input<String?>?
The machine type to use for the job.
final
maxWorkers → Input<int?>?
Immutable. The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.
final
name → Input<String?>?
Immutable. 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
numWorkers → Input<int?>?
Immutable. The initial number of Google Compute Engine instances for the job.
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?>?
Immutable. The region in which the created job should run.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sdkContainerImage → Input<String?>?
Docker registry location of container image to use for the 'worker harness. Default is the container for the version of the SDK. Note this field is only valid for portable pipelines.
final
serviceAccountEmail → Input<String?>?
Service account email to run the workers as. This should be just an email e.g. myserviceaccount@myproject.iam.gserviceaccount.com. Do not include any serviceAccount: or other prefix.
final
skipWaitOnJobTermination → Input<bool?>?
If set to true, terraform will treat DRAINING and CANCELLING as terminal states when deleting the resource, and will remove the resource from terraform state and move on. See above note.
final
stagingLocation → Input<String?>?
The Cloud Storage path to use for staging files. Must be a valid Cloud Storage URL, beginning with gs://.
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".
final
tempLocation → Input<String?>?
The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with gs://.
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.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.
final
type → Input<String?>?
The type of this job, selected from the JobType enum.
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