• Home
• com.google.apis
• google-api-services-dataflow
• v1b3-rev20231112-2.0.0
• source code
• RuntimeEnvironment.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.dataflow.model.RuntimeEnvironment.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.dataflow.model
Class RuntimeEnvironment



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 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
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() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


RuntimeEnvironment
clone() 


List<String>
getAdditionalExperiments()
Optional.



Map<String,String>
getAdditionalUserLabels()
Optional.



Boolean
getBypassTempDirValidation()
Optional.



Integer
getDiskSizeGb()
Optional.



Boolean
getEnableStreamingEngine()
Optional.



String
getIpConfiguration()
Optional.



String
getKmsKeyName()
Optional.



String
getMachineType()
Optional.



Integer
getMaxWorkers()
Optional.



String
getNetwork()
Optional.



Integer
getNumWorkers()
Optional.



String
getServiceAccountEmail()
Optional.



String
getSubnetwork()
Optional.



String
getTempLocation()
Required.



String
getWorkerRegion()
Required.



String
getWorkerZone()
Optional.



String
getZone()
Optional.



RuntimeEnvironment
set(String fieldName,
   Object value) 


RuntimeEnvironment
setAdditionalExperiments(List<String> additionalExperiments)
Optional.



RuntimeEnvironment
setAdditionalUserLabels(Map<String,String> additionalUserLabels)
Optional.



RuntimeEnvironment
setBypassTempDirValidation(Boolean bypassTempDirValidation)
Optional.



RuntimeEnvironment
setDiskSizeGb(Integer diskSizeGb)
Optional.



RuntimeEnvironment
setEnableStreamingEngine(Boolean enableStreamingEngine)
Optional.



RuntimeEnvironment
setIpConfiguration(String ipConfiguration)
Optional.



RuntimeEnvironment
setKmsKeyName(String kmsKeyName)
Optional.



RuntimeEnvironment
setMachineType(String machineType)
Optional.



RuntimeEnvironment
setMaxWorkers(Integer maxWorkers)
Optional.



RuntimeEnvironment
setNetwork(String network)
Optional.



RuntimeEnvironment
setNumWorkers(Integer numWorkers)
Optional.



RuntimeEnvironment
setServiceAccountEmail(String serviceAccountEmail)
Optional.



RuntimeEnvironment
setSubnetwork(String subnetwork)
Optional.



RuntimeEnvironment
setTempLocation(String tempLocation)
Required.



RuntimeEnvironment
setWorkerRegion(String workerRegion)
Required.



RuntimeEnvironment
setWorkerZone(String workerZone)
Optional.



RuntimeEnvironment
setZone(String zone)
Optional.







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()
Optional. Additional experiment flags for the job, specified with the `--experiments` option.

Returns:
value or null for none








setAdditionalExperiments
public RuntimeEnvironment setAdditionalExperiments(List<String> additionalExperiments)
Optional. Additional experiment flags for the job, specified with the `--experiments` option.

Parameters:
additionalExperiments - additionalExperiments or null for none








getAdditionalUserLabels
public Map<String,String> getAdditionalUserLabels()
Optional. 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)
Optional. 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()
Optional. 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)
Optional. Whether to bypass the safety checks for the job's temporary directory. Use with
 caution.

Parameters:
bypassTempDirValidation - bypassTempDirValidation or null for none








getDiskSizeGb
public Integer getDiskSizeGb()
Optional. The disk size, in gigabytes, to use on each remote Compute Engine worker instance.

Returns:
value or null for none








setDiskSizeGb
public RuntimeEnvironment setDiskSizeGb(Integer diskSizeGb)
Optional. The disk size, in gigabytes, to use on each remote Compute Engine worker instance.

Parameters:
diskSizeGb - diskSizeGb or null for none








getEnableStreamingEngine
public Boolean getEnableStreamingEngine()
Optional. Whether to enable Streaming Engine for the job.

Returns:
value or null for none








setEnableStreamingEngine
public RuntimeEnvironment setEnableStreamingEngine(Boolean enableStreamingEngine)
Optional. Whether to enable Streaming Engine for the job.

Parameters:
enableStreamingEngine - enableStreamingEngine or null for none








getIpConfiguration
public String getIpConfiguration()
Optional. Configuration for VM IPs.

Returns:
value or null for none








setIpConfiguration
public RuntimeEnvironment setIpConfiguration(String ipConfiguration)
Optional. Configuration for VM IPs.

Parameters:
ipConfiguration - ipConfiguration or null for none








getKmsKeyName
public String getKmsKeyName()
Optional. 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)
Optional. 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()
Optional. 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)
Optional. 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()
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.

Returns:
value or null for none








setMaxWorkers
public RuntimeEnvironment setMaxWorkers(Integer 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.

Parameters:
maxWorkers - maxWorkers or null for none








getNetwork
public String getNetwork()
Optional. 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)
Optional. 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()
Optional. The initial number of Google Compute Engine instances for the job. The default value
 is 11.

Returns:
value or null for none








setNumWorkers
public RuntimeEnvironment setNumWorkers(Integer numWorkers)
Optional. The initial number of Google Compute Engine instances for the job. The default value
 is 11.

Parameters:
numWorkers - numWorkers or null for none








getServiceAccountEmail
public String getServiceAccountEmail()
Optional. The email address of the service account to run the job as.

Returns:
value or null for none








setServiceAccountEmail
public RuntimeEnvironment setServiceAccountEmail(String serviceAccountEmail)
Optional. The email address of the service account to run the job as.

Parameters:
serviceAccountEmail - serviceAccountEmail or null for none








getSubnetwork
public String getSubnetwork()
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.goo
 gleapis.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.

Returns:
value or null for none








setSubnetwork
public RuntimeEnvironment setSubnetwork(String 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.goo
 gleapis.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.

Parameters:
subnetwork - subnetwork or null for none








getTempLocation
public String getTempLocation()
Required. 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)
Required. 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()
Required. 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)
Required. 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()
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.

Returns:
value or null for none








setWorkerZone
public RuntimeEnvironment setWorkerZone(String 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.

Parameters:
workerZone - workerZone or null for none








getZone
public String getZone()
Optional. 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)
Optional. 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 com.google.api.client.json.GenericJson








clone
public RuntimeEnvironment clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2023 Google. All rights reserved.