RuntimeEnvironment (Dataflow API v1b3 (Rev. 237) 1.23.0)

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

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class RuntimeEnvironment
extends com.google.api.client.json.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
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

RuntimeEnvironment()

Constructors
Constructor and Description
`RuntimeEnvironment()`

Method Summary

Methods
Modifier and Type	Method and Description
`RuntimeEnvironment`	`clone()`
`java.util.List<java.lang.String>`	`getAdditionalExperiments()` Additional experiment flags for the job.
`java.lang.Boolean`	`getBypassTempDirValidation()` Whether to bypass the safety checks for the job's temporary directory.
`java.lang.String`	`getMachineType()` The machine type to use for the job.
`java.lang.Integer`	`getMaxWorkers()` The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.
`java.lang.String`	`getNetwork()` Network to which VMs will be assigned.
`java.lang.String`	`getServiceAccountEmail()` The email address of the service account to run the job as.
`java.lang.String`	`getSubnetwork()` Subnetwork to which VMs will be assigned, if desired.
`java.lang.String`	`getTempLocation()` The Cloud Storage path to use for temporary files.
`java.lang.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(java.lang.String fieldName, java.lang.Object value)`
`RuntimeEnvironment`	`setAdditionalExperiments(java.util.List<java.lang.String> additionalExperiments)` Additional experiment flags for the job.
`RuntimeEnvironment`	`setBypassTempDirValidation(java.lang.Boolean bypassTempDirValidation)` Whether to bypass the safety checks for the job's temporary directory.
`RuntimeEnvironment`	`setMachineType(java.lang.String machineType)` The machine type to use for the job.
`RuntimeEnvironment`	`setMaxWorkers(java.lang.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(java.lang.String network)` Network to which VMs will be assigned.
`RuntimeEnvironment`	`setServiceAccountEmail(java.lang.String serviceAccountEmail)` The email address of the service account to run the job as.
`RuntimeEnvironment`	`setSubnetwork(java.lang.String subnetwork)` Subnetwork to which VMs will be assigned, if desired.
`RuntimeEnvironment`	`setTempLocation(java.lang.String tempLocation)` The Cloud Storage path to use for temporary files.
`RuntimeEnvironment`	`setZone(java.lang.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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

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

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

- Constructor Detail
  - RuntimeEnvironment
```
public RuntimeEnvironment()
```
- Method Detail
  - getAdditionalExperiments
```
public java.util.List<java.lang.String> getAdditionalExperiments()
```
    Additional experiment flags for the job.
    
    Returns:
    value or null for none
  - setAdditionalExperiments
```
public RuntimeEnvironment setAdditionalExperiments(java.util.List<java.lang.String> additionalExperiments)
```
    Additional experiment flags for the job.
    
    Parameters:
    additionalExperiments - additionalExperiments or null for none
  - getBypassTempDirValidation
```
public java.lang.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(java.lang.Boolean bypassTempDirValidation)
```
    Whether to bypass the safety checks for the job's temporary directory. Use with caution.
    
    Parameters:
    bypassTempDirValidation - bypassTempDirValidation or null for none
  - getMachineType
```
public java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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
  - getServiceAccountEmail
```
public java.lang.String getServiceAccountEmail()
```
    The email address of the service account to run the job as.
    
    Returns:
    value or null for none
  - setServiceAccountEmail
```
public RuntimeEnvironment setServiceAccountEmail(java.lang.String serviceAccountEmail)
```
    The email address of the service account to run the job as.
    
    Parameters:
    serviceAccountEmail - serviceAccountEmail or null for none
  - getSubnetwork
```
public java.lang.String getSubnetwork()
```
    Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK".
    
    Returns:
    value or null for none
  - setSubnetwork
```
public RuntimeEnvironment setSubnetwork(java.lang.String subnetwork)
```
    Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK".
    
    Parameters:
    subnetwork - subnetwork or null for none
  - getTempLocation
```
public java.lang.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(java.lang.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
  - getZone
```
public java.lang.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.
    
    Returns:
    value or null for none
  - setZone
```
public RuntimeEnvironment setZone(java.lang.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.
    
    Parameters:
    zone - zone or null for none
  - set
```
public RuntimeEnvironment set(java.lang.String fieldName,
                     java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public RuntimeEnvironment clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Dataflow API v1b3 (revision 237)

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

Constructor Detail

RuntimeEnvironment

Method Detail

getAdditionalExperiments

setAdditionalExperiments

getBypassTempDirValidation

setBypassTempDirValidation

getMachineType

setMachineType

getMaxWorkers

setMaxWorkers

getNetwork

setNetwork

getServiceAccountEmail

setServiceAccountEmail

getSubnetwork

setSubnetwork

getTempLocation

setTempLocation

getZone

setZone

set

clone