RuntimeEnvironment class

The environment values to set at runtime.

Constructors

RuntimeEnvironment({Input<List<String>>? additionalExperiments, Input<Map<String, String>>? additionalUserLabels, Input<bool>? bypassTempDirValidation, Input<int>? diskSizeGb, Input<bool>? enableStreamingEngine, Input<RuntimeEnvironmentIpConfiguration>? ipConfiguration, Input<String>? kmsKeyName, Input<String>? machineType, Input<int>? maxWorkers, Input<String>? network, Input<int>? numWorkers, Input<String>? serviceAccountEmail, Input<String>? subnetwork, required Input<String> tempLocation, required Input<String> workerRegion, Input<String>? workerZone, Input<String>? zone})
Creates a new RuntimeEnvironment. additionalExperiments Optional. Additional experiment flags for the job, specified with the --experiments option. additionalUserLabels Optional. Additional user labels to be specified for the job. Keys and values should follow the restrictions specified in the labeling restrictions page. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" }. bypassTempDirValidation Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution. diskSizeGb Optional. The disk size, in gigabytes, to use on each remote Compute Engine worker instance. enableStreamingEngine Optional. Whether to enable Streaming Engine for the job. ipConfiguration Optional. Configuration for VM IPs. kmsKeyName Optional. Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/ machineType Optional. The machine type to use for the job. Defaults to the value from the template if not specified. maxWorkers Optional. The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000. The default value is 1. network Optional. Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". numWorkers Optional. The initial number of Google Compute Engine instances for the job. The default value is 11. serviceAccountEmail Optional. The email address of the service account to run the job as. subnetwork Optional. Subnetwork to which VMs will be assigned, if desired. You can specify a subnetwork using either a complete URL or an abbreviated path. Expected to be of the form "https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK" or "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is located in a Shared VPC network, you must use the complete URL. tempLocation The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with gs://. workerRegion The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region. workerZone Optional. The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane's region is chosen based on available capacity. If both worker_zone and zone are set, worker_zone takes precedence. zone Optional. The Compute Engine availability zone for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.
const
RuntimeEnvironment.fromMap(Map<String, dynamic> map)
factory

Properties

additionalExperiments → Input<List<String>>?
Optional. Additional experiment flags for the job, specified with the --experiments option.
final
additionalUserLabels → Input<Map<String, String>>?
Optional. Additional user labels to be specified for the job. Keys and values should follow the restrictions specified in the labeling restrictions page. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" }.
final
bypassTempDirValidation → Input<bool>?
Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution.
final
diskSizeGb → Input<int>?
Optional. The disk size, in gigabytes, to use on each remote Compute Engine worker instance.
final
enableStreamingEngine → Input<bool>?
Optional. Whether to enable Streaming Engine for the job.
final
hashCode → int
The hash code for this object.
no setterinherited
ipConfiguration → Input<RuntimeEnvironmentIpConfiguration>?
Optional. Configuration for VM IPs.
final
kmsKeyName → Input<String>?
Optional. Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/
final
machineType → Input<String>?
Optional. The machine type to use for the job. Defaults to the value from the template if not specified.
final
maxWorkers → Input<int>?
Optional. The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000. The default value is 1.
final
network → Input<String>?
Optional. Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
final
numWorkers → Input<int>?
Optional. The initial number of Google Compute Engine instances for the job. The default value is 11.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
serviceAccountEmail → Input<String>?
Optional. The email address of the service account to run the job as.
final
subnetwork → Input<String>?
Optional. Subnetwork to which VMs will be assigned, if desired. You can specify a subnetwork using either a complete URL or an abbreviated path. Expected to be of the form "https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK" or "regions/REGION/subnetworks/SUBNETWORK". If the subnetwork is located in a Shared VPC network, you must use the complete URL.
final
tempLocation → Input<String>
The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with gs://.
final
workerRegion → Input<String>
The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region.
final
workerZone → Input<String>?
Optional. The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane's region is chosen based on available capacity. If both worker_zone and zone are set, worker_zone takes precedence.
final
zone → Input<String>?
Optional. The Compute Engine availability zone for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.
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