RuntimeEnvironmentArgs

data class RuntimeEnvironmentArgs(val additionalExperiments: Output<List<String>>? = null, val additionalUserLabels: Output<Map<String, String>>? = null, val bypassTempDirValidation: Output<Boolean>? = null, val enableStreamingEngine: Output<Boolean>? = null, val ipConfiguration: Output<RuntimeEnvironmentIpConfiguration>? = null, val kmsKeyName: Output<String>? = null, val machineType: Output<String>? = null, val maxWorkers: Output<Int>? = null, val network: Output<String>? = null, val numWorkers: Output<Int>? = null, val serviceAccountEmail: Output<String>? = null, val subnetwork: Output<String>? = null, val tempLocation: Output<String>, val workerRegion: Output<String>, val workerZone: Output<String>? = null, val zone: Output<String>? = null) : ConvertibleToJava<RuntimeEnvironmentArgs>

The environment values to set at runtime.

Constructors

Link copied to clipboard
fun RuntimeEnvironmentArgs(additionalExperiments: Output<List<String>>? = null, additionalUserLabels: Output<Map<String, String>>? = null, bypassTempDirValidation: Output<Boolean>? = null, enableStreamingEngine: Output<Boolean>? = null, ipConfiguration: Output<RuntimeEnvironmentIpConfiguration>? = null, kmsKeyName: Output<String>? = null, machineType: Output<String>? = null, maxWorkers: Output<Int>? = null, network: Output<String>? = null, numWorkers: Output<Int>? = null, serviceAccountEmail: Output<String>? = null, subnetwork: Output<String>? = null, tempLocation: Output<String>, workerRegion: Output<String>, workerZone: Output<String>? = null, zone: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): RuntimeEnvironmentArgs

Properties

Link copied to clipboard
val additionalExperiments: Output<List<String>>? = null

Optional. Additional experiment flags for the job, specified with the --experiments option.

Link copied to clipboard
val additionalUserLabels: Output<Map<String, String>>? = null

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" }.

Link copied to clipboard
val bypassTempDirValidation: Output<Boolean>? = null

Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution.

Link copied to clipboard
val enableStreamingEngine: Output<Boolean>? = null

Optional. Whether to enable Streaming Engine for the job.

Link copied to clipboard

Optional. Configuration for VM IPs.

Link copied to clipboard
val kmsKeyName: Output<String>? = null

Optional. Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/

Link copied to clipboard
val machineType: Output<String>? = null

Optional. The machine type to use for the job. Defaults to the value from the template if not specified.

Link copied to clipboard
val maxWorkers: Output<Int>? = null

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.

Link copied to clipboard
val network: Output<String>? = null

Optional. Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".

Link copied to clipboard
val numWorkers: Output<Int>? = null

Optional. The initial number of Google Compute Engine instances for the job. The default value is 11.

Link copied to clipboard
val serviceAccountEmail: Output<String>? = null

Optional. The email address of the service account to run the job as.

Link copied to clipboard
val subnetwork: Output<String>? = null

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.

Link copied to clipboard
val tempLocation: Output<String>

The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with gs://.

Link copied to clipboard
val workerRegion: Output<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.

Link copied to clipboard
val workerZone: Output<String>? = null

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.

Link copied to clipboard
val zone: Output<String>? = null

Optional. The Compute Engine availability zone for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.