target.apidocs.com.google.api.services.dataflow.model.FlexTemplateRuntimeEnvironment.html Maven / Gradle / Ivy
FlexTemplateRuntimeEnvironment (Dataflow API v1b3-rev20231112-2.0.0)
com.google.api.services.dataflow.model
Class FlexTemplateRuntimeEnvironment
- 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.FlexTemplateRuntimeEnvironment
-
public final class FlexTemplateRuntimeEnvironment
extends com.google.api.client.json.GenericJson
The environment values to be set at runtime for flex template.
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>
-
Constructor Summary
Constructors
Constructor and Description
FlexTemplateRuntimeEnvironment()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
FlexTemplateRuntimeEnvironment
clone()
List<String>
getAdditionalExperiments()
Additional experiment flags for the job.
Map<String,String>
getAdditionalUserLabels()
Additional user labels to be specified for the job.
String
getAutoscalingAlgorithm()
The algorithm to use for autoscaling
Integer
getDiskSizeGb()
Worker disk size, in gigabytes.
Boolean
getDumpHeapOnOom()
If true, when processing time is spent almost entirely on garbage collection (GC), saves a heap
dump before ending the thread or process.
Boolean
getEnableLauncherVmSerialPortLogging()
If true serial port logging will be enabled for the launcher VM.
Boolean
getEnableStreamingEngine()
Whether to enable Streaming Engine for the job.
String
getFlexrsGoal()
Set FlexRS goal for the job.
String
getIpConfiguration()
Configuration for VM IPs.
String
getKmsKeyName()
Name for the Cloud KMS key for the job.
String
getLauncherMachineType()
The machine type to use for launching 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 instances for the job.
String
getSaveHeapDumpsToGcsPath()
Cloud Storage bucket (directory) to upload heap dumps to.
String
getSdkContainerImage()
Docker registry location of container image to use for the 'worker harness.
String
getServiceAccountEmail()
The email address of the service account to run the job as.
String
getStagingLocation()
The Cloud Storage path for staging local files.
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.
FlexTemplateRuntimeEnvironment
set(String fieldName,
Object value)
FlexTemplateRuntimeEnvironment
setAdditionalExperiments(List<String> additionalExperiments)
Additional experiment flags for the job.
FlexTemplateRuntimeEnvironment
setAdditionalUserLabels(Map<String,String> additionalUserLabels)
Additional user labels to be specified for the job.
FlexTemplateRuntimeEnvironment
setAutoscalingAlgorithm(String autoscalingAlgorithm)
The algorithm to use for autoscaling
FlexTemplateRuntimeEnvironment
setDiskSizeGb(Integer diskSizeGb)
Worker disk size, in gigabytes.
FlexTemplateRuntimeEnvironment
setDumpHeapOnOom(Boolean dumpHeapOnOom)
If true, when processing time is spent almost entirely on garbage collection (GC), saves a heap
dump before ending the thread or process.
FlexTemplateRuntimeEnvironment
setEnableLauncherVmSerialPortLogging(Boolean enableLauncherVmSerialPortLogging)
If true serial port logging will be enabled for the launcher VM.
FlexTemplateRuntimeEnvironment
setEnableStreamingEngine(Boolean enableStreamingEngine)
Whether to enable Streaming Engine for the job.
FlexTemplateRuntimeEnvironment
setFlexrsGoal(String flexrsGoal)
Set FlexRS goal for the job.
FlexTemplateRuntimeEnvironment
setIpConfiguration(String ipConfiguration)
Configuration for VM IPs.
FlexTemplateRuntimeEnvironment
setKmsKeyName(String kmsKeyName)
Name for the Cloud KMS key for the job.
FlexTemplateRuntimeEnvironment
setLauncherMachineType(String launcherMachineType)
The machine type to use for launching the job.
FlexTemplateRuntimeEnvironment
setMachineType(String machineType)
The machine type to use for the job.
FlexTemplateRuntimeEnvironment
setMaxWorkers(Integer maxWorkers)
The maximum number of Google Compute Engine instances to be made available to your pipeline
during execution, from 1 to 1000.
FlexTemplateRuntimeEnvironment
setNetwork(String network)
Network to which VMs will be assigned.
FlexTemplateRuntimeEnvironment
setNumWorkers(Integer numWorkers)
The initial number of Google Compute Engine instances for the job.
FlexTemplateRuntimeEnvironment
setSaveHeapDumpsToGcsPath(String saveHeapDumpsToGcsPath)
Cloud Storage bucket (directory) to upload heap dumps to.
FlexTemplateRuntimeEnvironment
setSdkContainerImage(String sdkContainerImage)
Docker registry location of container image to use for the 'worker harness.
FlexTemplateRuntimeEnvironment
setServiceAccountEmail(String serviceAccountEmail)
The email address of the service account to run the job as.
FlexTemplateRuntimeEnvironment
setStagingLocation(String stagingLocation)
The Cloud Storage path for staging local files.
FlexTemplateRuntimeEnvironment
setSubnetwork(String subnetwork)
Subnetwork to which VMs will be assigned, if desired.
FlexTemplateRuntimeEnvironment
setTempLocation(String tempLocation)
The Cloud Storage path to use for temporary files.
FlexTemplateRuntimeEnvironment
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.
FlexTemplateRuntimeEnvironment
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.
FlexTemplateRuntimeEnvironment
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
-
-
Method Detail
-
getAdditionalExperiments
public List<String> getAdditionalExperiments()
Additional experiment flags for the job.
- Returns:
- value or
null
for none
-
setAdditionalExperiments
public FlexTemplateRuntimeEnvironment setAdditionalExperiments(List<String> additionalExperiments)
Additional experiment flags for the job.
- 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 must 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 FlexTemplateRuntimeEnvironment setAdditionalUserLabels(Map<String,String> additionalUserLabels)
Additional user labels to be specified for the job. Keys and values must 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
-
getAutoscalingAlgorithm
public String getAutoscalingAlgorithm()
The algorithm to use for autoscaling
- Returns:
- value or
null
for none
-
setAutoscalingAlgorithm
public FlexTemplateRuntimeEnvironment setAutoscalingAlgorithm(String autoscalingAlgorithm)
The algorithm to use for autoscaling
- Parameters:
autoscalingAlgorithm
- autoscalingAlgorithm or null
for none
-
getDiskSizeGb
public Integer getDiskSizeGb()
Worker disk size, in gigabytes.
- Returns:
- value or
null
for none
-
setDiskSizeGb
public FlexTemplateRuntimeEnvironment setDiskSizeGb(Integer diskSizeGb)
Worker disk size, in gigabytes.
- Parameters:
diskSizeGb
- diskSizeGb or null
for none
-
getDumpHeapOnOom
public Boolean getDumpHeapOnOom()
If true, when processing time is spent almost entirely on garbage collection (GC), saves a heap
dump before ending the thread or process. If false, ends the thread or process without saving a
heap dump. Does not save a heap dump when the Java Virtual Machine (JVM) has an out of memory
error during processing. The location of the heap file is either echoed back to the user, or
the user is given the opportunity to download the heap file.
- Returns:
- value or
null
for none
-
setDumpHeapOnOom
public FlexTemplateRuntimeEnvironment setDumpHeapOnOom(Boolean dumpHeapOnOom)
If true, when processing time is spent almost entirely on garbage collection (GC), saves a heap
dump before ending the thread or process. If false, ends the thread or process without saving a
heap dump. Does not save a heap dump when the Java Virtual Machine (JVM) has an out of memory
error during processing. The location of the heap file is either echoed back to the user, or
the user is given the opportunity to download the heap file.
- Parameters:
dumpHeapOnOom
- dumpHeapOnOom or null
for none
-
getEnableLauncherVmSerialPortLogging
public Boolean getEnableLauncherVmSerialPortLogging()
If true serial port logging will be enabled for the launcher VM.
- Returns:
- value or
null
for none
-
setEnableLauncherVmSerialPortLogging
public FlexTemplateRuntimeEnvironment setEnableLauncherVmSerialPortLogging(Boolean enableLauncherVmSerialPortLogging)
If true serial port logging will be enabled for the launcher VM.
- Parameters:
enableLauncherVmSerialPortLogging
- enableLauncherVmSerialPortLogging or null
for none
-
getEnableStreamingEngine
public Boolean getEnableStreamingEngine()
Whether to enable Streaming Engine for the job.
- Returns:
- value or
null
for none
-
setEnableStreamingEngine
public FlexTemplateRuntimeEnvironment setEnableStreamingEngine(Boolean enableStreamingEngine)
Whether to enable Streaming Engine for the job.
- Parameters:
enableStreamingEngine
- enableStreamingEngine or null
for none
-
getFlexrsGoal
public String getFlexrsGoal()
Set FlexRS goal for the job. https://cloud.google.com/dataflow/docs/guides/flexrs
- Returns:
- value or
null
for none
-
setFlexrsGoal
public FlexTemplateRuntimeEnvironment setFlexrsGoal(String flexrsGoal)
Set FlexRS goal for the job. https://cloud.google.com/dataflow/docs/guides/flexrs
- Parameters:
flexrsGoal
- flexrsGoal or null
for none
-
getIpConfiguration
public String getIpConfiguration()
Configuration for VM IPs.
- Returns:
- value or
null
for none
-
setIpConfiguration
public FlexTemplateRuntimeEnvironment 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 FlexTemplateRuntimeEnvironment 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
-
getLauncherMachineType
public String getLauncherMachineType()
The machine type to use for launching the job. The default is n1-standard-1.
- Returns:
- value or
null
for none
-
setLauncherMachineType
public FlexTemplateRuntimeEnvironment setLauncherMachineType(String launcherMachineType)
The machine type to use for launching the job. The default is n1-standard-1.
- Parameters:
launcherMachineType
- launcherMachineType 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 FlexTemplateRuntimeEnvironment 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 FlexTemplateRuntimeEnvironment 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 FlexTemplateRuntimeEnvironment 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 instances for the job.
- Returns:
- value or
null
for none
-
setNumWorkers
public FlexTemplateRuntimeEnvironment setNumWorkers(Integer numWorkers)
The initial number of Google Compute Engine instances for the job.
- Parameters:
numWorkers
- numWorkers or null
for none
-
getSaveHeapDumpsToGcsPath
public String getSaveHeapDumpsToGcsPath()
Cloud Storage bucket (directory) to upload heap dumps to. Enabling this field implies that
`dump_heap_on_oom` is set to true.
- Returns:
- value or
null
for none
-
setSaveHeapDumpsToGcsPath
public FlexTemplateRuntimeEnvironment setSaveHeapDumpsToGcsPath(String saveHeapDumpsToGcsPath)
Cloud Storage bucket (directory) to upload heap dumps to. Enabling this field implies that
`dump_heap_on_oom` is set to true.
- Parameters:
saveHeapDumpsToGcsPath
- saveHeapDumpsToGcsPath or null
for none
-
getSdkContainerImage
public String getSdkContainerImage()
Docker registry location of container image to use for the 'worker harness. Default is the
container for the version of the SDK. Note this field is only valid for portable pipelines.
- Returns:
- value or
null
for none
-
setSdkContainerImage
public FlexTemplateRuntimeEnvironment setSdkContainerImage(String sdkContainerImage)
Docker registry location of container image to use for the 'worker harness. Default is the
container for the version of the SDK. Note this field is only valid for portable pipelines.
- Parameters:
sdkContainerImage
- sdkContainerImage 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 FlexTemplateRuntimeEnvironment setServiceAccountEmail(String serviceAccountEmail)
The email address of the service account to run the job as.
- Parameters:
serviceAccountEmail
- serviceAccountEmail or null
for none
-
getStagingLocation
public String getStagingLocation()
The Cloud Storage path for staging local files. Must be a valid Cloud Storage URL, beginning
with `gs://`.
- Returns:
- value or
null
for none
-
setStagingLocation
public FlexTemplateRuntimeEnvironment setStagingLocation(String stagingLocation)
The Cloud Storage path for staging local files. Must be a valid Cloud Storage URL, beginning
with `gs://`.
- Parameters:
stagingLocation
- stagingLocation 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 FlexTemplateRuntimeEnvironment 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 FlexTemplateRuntimeEnvironment 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 FlexTemplateRuntimeEnvironment 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 FlexTemplateRuntimeEnvironment 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 FlexTemplateRuntimeEnvironment 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 FlexTemplateRuntimeEnvironment set(String fieldName,
Object value)
- Overrides:
set
in class com.google.api.client.json.GenericJson
-
clone
public FlexTemplateRuntimeEnvironment clone()
- Overrides:
clone
in class com.google.api.client.json.GenericJson
Copyright © 2011–2023 Google. All rights reserved.
© 2015 - 2024 Weber Informatics LLC | Privacy Policy