RuntimeEnvironment (Dataflow API v1b3-rev20210818-1.32.1)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.dataflow.model.RuntimeEnvironment

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class RuntimeEnvironment
extends GenericJson
```
The environment values to set at runtime.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Dataflow API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

RuntimeEnvironment()

Constructors
Constructor and Description
`RuntimeEnvironment()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RuntimeEnvironment`	`clone()`
`List<String>`	`getAdditionalExperiments()` Additional experiment flags for the job, specified with the `--experiments` option.
`Map<String,String>`	`getAdditionalUserLabels()` Additional user labels to be specified for the job.
`Boolean`	`getBypassTempDirValidation()` Whether to bypass the safety checks for the job's temporary directory.
`Boolean`	`getEnableStreamingEngine()` Whether to enable Streaming Engine for the job.
`String`	`getIpConfiguration()` Configuration for VM IPs.
`String`	`getKmsKeyName()` Name for the Cloud KMS key for the job.
`String`	`getMachineType()` The machine type to use for the job.
`Integer`	`getMaxWorkers()` The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.
`String`	`getNetwork()` Network to which VMs will be assigned.
`Integer`	`getNumWorkers()` The initial number of Google Compute Engine instnaces for the job.
`String`	`getServiceAccountEmail()` The email address of the service account to run the job as.
`String`	`getSubnetwork()` Subnetwork to which VMs will be assigned, if desired.
`String`	`getTempLocation()` The Cloud Storage path to use for temporary files.
`String`	`getWorkerRegion()` The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g.
`String`	`getWorkerZone()` The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g.
`String`	`getZone()` The Compute Engine [availability zone](https://cloud.google.com/compute/docs/regions-zones /regions-zones) for launching worker instances to run your pipeline.
`RuntimeEnvironment`	`set(String fieldName, Object value)`
`RuntimeEnvironment`	`setAdditionalExperiments(List<String> additionalExperiments)` Additional experiment flags for the job, specified with the `--experiments` option.
`RuntimeEnvironment`	`setAdditionalUserLabels(Map<String,String> additionalUserLabels)` Additional user labels to be specified for the job.
`RuntimeEnvironment`	`setBypassTempDirValidation(Boolean bypassTempDirValidation)` Whether to bypass the safety checks for the job's temporary directory.
`RuntimeEnvironment`	`setEnableStreamingEngine(Boolean enableStreamingEngine)` Whether to enable Streaming Engine for the job.
`RuntimeEnvironment`	`setIpConfiguration(String ipConfiguration)` Configuration for VM IPs.
`RuntimeEnvironment`	`setKmsKeyName(String kmsKeyName)` Name for the Cloud KMS key for the job.
`RuntimeEnvironment`	`setMachineType(String machineType)` The machine type to use for the job.
`RuntimeEnvironment`	`setMaxWorkers(Integer maxWorkers)` The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.
`RuntimeEnvironment`	`setNetwork(String network)` Network to which VMs will be assigned.
`RuntimeEnvironment`	`setNumWorkers(Integer numWorkers)` The initial number of Google Compute Engine instnaces for the job.
`RuntimeEnvironment`	`setServiceAccountEmail(String serviceAccountEmail)` The email address of the service account to run the job as.
`RuntimeEnvironment`	`setSubnetwork(String subnetwork)` Subnetwork to which VMs will be assigned, if desired.
`RuntimeEnvironment`	`setTempLocation(String tempLocation)` The Cloud Storage path to use for temporary files.
`RuntimeEnvironment`	`setWorkerRegion(String workerRegion)` The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g.
`RuntimeEnvironment`	`setWorkerZone(String workerZone)` The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g.
`RuntimeEnvironment`	`setZone(String zone)` The Compute Engine [availability zone](https://cloud.google.com/compute/docs/regions-zones /regions-zones) for launching worker instances to run your pipeline.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - RuntimeEnvironment
```
public RuntimeEnvironment()
```
- Method Detail
  - getAdditionalExperiments
```
public List<String> getAdditionalExperiments()
```
    Additional experiment flags for the job, specified with the `--experiments` option.
    
    Returns:
    
    value or null for none
  - setAdditionalExperiments
```
public RuntimeEnvironment setAdditionalExperiments(List<String> additionalExperiments)
```
    Additional experiment flags for the job, specified with the `--experiments` option.
    
    Parameters:
    
    additionalExperiments - additionalExperiments or null for none
  - getAdditionalUserLabels
```
public Map<String,String> getAdditionalUserLabels()
```
    Additional user labels to be specified for the job. Keys and values should follow the restrictions specified in the [labeling restrictions](https://cloud.google.com/compute/docs /labeling-resources#restrictions) page. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" }.
    
    Returns:
    
    value or null for none
  - setAdditionalUserLabels
```
public RuntimeEnvironment setAdditionalUserLabels(Map<String,String> additionalUserLabels)
```
    Additional user labels to be specified for the job. Keys and values should follow the restrictions specified in the [labeling restrictions](https://cloud.google.com/compute/docs /labeling-resources#restrictions) page. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1kg", "count": "3" }.
    
    Parameters:
    
    additionalUserLabels - additionalUserLabels or null for none
  - getBypassTempDirValidation
```
public Boolean getBypassTempDirValidation()
```
    Whether to bypass the safety checks for the job's temporary directory. Use with caution.
    
    Returns:
    
    value or null for none
  - setBypassTempDirValidation
```
public RuntimeEnvironment setBypassTempDirValidation(Boolean bypassTempDirValidation)
```
    Whether to bypass the safety checks for the job's temporary directory. Use with caution.
    
    Parameters:
    
    bypassTempDirValidation - bypassTempDirValidation or null for none
  - getEnableStreamingEngine
```
public Boolean getEnableStreamingEngine()
```
    Whether to enable Streaming Engine for the job.
    
    Returns:
    
    value or null for none
  - setEnableStreamingEngine
```
public RuntimeEnvironment setEnableStreamingEngine(Boolean enableStreamingEngine)
```
    Whether to enable Streaming Engine for the job.
    
    Parameters:
    
    enableStreamingEngine - enableStreamingEngine or null for none
  - getIpConfiguration
```
public String getIpConfiguration()
```
    Configuration for VM IPs.
    
    Returns:
    
    value or null for none
  - setIpConfiguration
```
public RuntimeEnvironment setIpConfiguration(String ipConfiguration)
```
    Configuration for VM IPs.
    
    Parameters:
    
    ipConfiguration - ipConfiguration or null for none
  - getKmsKeyName
```
public String getKmsKeyName()
```
    Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/
    
    Returns:
    
    value or null for none
  - setKmsKeyName
```
public RuntimeEnvironment setKmsKeyName(String kmsKeyName)
```
    Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/
    
    Parameters:
    
    kmsKeyName - kmsKeyName or null for none
  - getMachineType
```
public String getMachineType()
```
    The machine type to use for the job. Defaults to the value from the template if not specified.
    
    Returns:
    
    value or null for none
  - setMachineType
```
public RuntimeEnvironment setMachineType(String machineType)
```
    The machine type to use for the job. Defaults to the value from the template if not specified.
    
    Parameters:
    
    machineType - machineType or null for none
  - getMaxWorkers
```
public Integer getMaxWorkers()
```
    The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.
    
    Returns:
    
    value or null for none
  - setMaxWorkers
```
public RuntimeEnvironment setMaxWorkers(Integer maxWorkers)
```
    The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.
    
    Parameters:
    
    maxWorkers - maxWorkers or null for none
  - getNetwork
```
public String getNetwork()
```
    Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
    
    Returns:
    
    value or null for none
  - setNetwork
```
public RuntimeEnvironment setNetwork(String network)
```
    Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
    
    Parameters:
    
    network - network or null for none
  - getNumWorkers
```
public Integer getNumWorkers()
```
    The initial number of Google Compute Engine instnaces for the job.
    
    Returns:
    
    value or null for none
  - setNumWorkers
```
public RuntimeEnvironment setNumWorkers(Integer numWorkers)
```
    The initial number of Google Compute Engine instnaces for the job.
    
    Parameters:
    
    numWorkers - numWorkers or null for none
  - getServiceAccountEmail
```
public String getServiceAccountEmail()
```
    The email address of the service account to run the job as.
    
    Returns:
    
    value or null for none
  - setServiceAccountEmail
```
public RuntimeEnvironment setServiceAccountEmail(String serviceAccountEmail)
```
    The email address of the service account to run the job as.
    
    Parameters:
    
    serviceAccountEmail - serviceAccountEmail or null for none
  - getSubnetwork
```
public String getSubnetwork()
```
    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/c ompute/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.
    
    Returns:
    
    value or null for none
  - setSubnetwork
```
public RuntimeEnvironment setSubnetwork(String subnetwork)
```
    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/c ompute/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.
    
    Parameters:
    
    subnetwork - subnetwork or null for none
  - getTempLocation
```
public String getTempLocation()
```
    The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.
    
    Returns:
    
    value or null for none
  - setTempLocation
```
public RuntimeEnvironment setTempLocation(String tempLocation)
```
    The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.
    
    Parameters:
    
    tempLocation - tempLocation or null for none
  - getWorkerRegion
```
public String getWorkerRegion()
```
    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.
    
    Returns:
    
    value or null for none
  - setWorkerRegion
```
public RuntimeEnvironment setWorkerRegion(String 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.
    
    Parameters:
    
    workerRegion - workerRegion or null for none
  - getWorkerZone
```
public String getWorkerZone()
```
    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.
    
    Returns:
    
    value or null for none
  - setWorkerZone
```
public RuntimeEnvironment setWorkerZone(String workerZone)
```
    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.
    
    Parameters:
    
    workerZone - workerZone or null for none
  - getZone
```
public String getZone()
```
    The Compute Engine [availability zone](https://cloud.google.com/compute/docs/regions-zones /regions-zones) for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.
    
    Returns:
    
    value or null for none
  - setZone
```
public RuntimeEnvironment setZone(String zone)
```
    The Compute Engine [availability zone](https://cloud.google.com/compute/docs/regions-zones /regions-zones) for launching worker instances to run your pipeline. In the future, worker_zone will take precedence.
    
    Parameters:
    
    zone - zone or null for none
  - set
```
public RuntimeEnvironment set(String fieldName,
                              Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public RuntimeEnvironment clone()
```
    Overrides:
    
    clone in class GenericJson

Class RuntimeEnvironment

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

RuntimeEnvironment

Method Detail

getAdditionalExperiments

setAdditionalExperiments

getAdditionalUserLabels

setAdditionalUserLabels

getBypassTempDirValidation

setBypassTempDirValidation

getEnableStreamingEngine

setEnableStreamingEngine

getIpConfiguration

setIpConfiguration

getKmsKeyName

setKmsKeyName

getMachineType

setMachineType

getMaxWorkers

setMaxWorkers

getNetwork

setNetwork

getNumWorkers

setNumWorkers

getServiceAccountEmail

setServiceAccountEmail

getSubnetwork

setSubnetwork

getTempLocation

setTempLocation

getWorkerRegion

setWorkerRegion

getWorkerZone

setWorkerZone

getZone

setZone

set

clone