WorkerPool (Dataflow API v1b3 (Rev. 278) 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.WorkerPool

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class WorkerPool
extends com.google.api.client.json.GenericJson
```
Describes one particular pool of Cloud Dataflow workers to be instantiated by the Cloud Dataflow service in order to perform the computations required by a job. Note that a workflow job may use multiple pools, in order to match the various computational requirements of the various stages of the job.
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

WorkerPool()

Constructors
Constructor and Description
`WorkerPool()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WorkerPool`	`clone()`
`AutoscalingSettings`	`getAutoscalingSettings()` Settings for autoscaling of this WorkerPool.
`java.util.List<Disk>`	`getDataDisks()` Data disks that are used by a VM in this workflow.
`java.lang.String`	`getDefaultPackageSet()` The default package set to install.
`java.lang.Integer`	`getDiskSizeGb()` Size of root disk for VMs, in GB.
`java.lang.String`	`getDiskSourceImage()` Fully qualified source image for disks.
`java.lang.String`	`getDiskType()` Type of root disk for VMs.
`java.lang.String`	`getIpConfiguration()` Configuration for VM IPs.
`java.lang.String`	`getKind()` The kind of the worker pool; currently only `harness` and `shuffle` are supported.
`java.lang.String`	`getMachineType()` Machine type (e.g.
`java.util.Map<java.lang.String,java.lang.String>`	`getMetadata()` Metadata to set on the Google Compute Engine VMs.
`java.lang.String`	`getNetwork()` Network to which VMs will be assigned.
`java.lang.Integer`	`getNumThreadsPerWorker()` The number of threads per worker harness.
`java.lang.Integer`	`getNumWorkers()` Number of Google Compute Engine workers in this pool needed to execute the job.
`java.lang.String`	`getOnHostMaintenance()` The action to take on host maintenance, as defined by the Google Compute Engine API.
`java.util.List<DataflowPackage>`	`getPackages()` Packages to be installed on workers.
`java.util.Map<java.lang.String,java.lang.Object>`	`getPoolArgs()` Extra arguments for this worker pool.
`java.lang.String`	`getSubnetwork()` Subnetwork to which VMs will be assigned, if desired.
`TaskRunnerSettings`	`getTaskrunnerSettings()` Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner.
`java.lang.String`	`getTeardownPolicy()` Sets the policy for determining when to turndown worker pool.
`java.lang.String`	`getWorkerHarnessContainerImage()` Required.
`java.lang.String`	`getZone()` Zone to run the worker pools in.
`WorkerPool`	`set(java.lang.String fieldName, java.lang.Object value)`
`WorkerPool`	`setAutoscalingSettings(AutoscalingSettings autoscalingSettings)` Settings for autoscaling of this WorkerPool.
`WorkerPool`	`setDataDisks(java.util.List<Disk> dataDisks)` Data disks that are used by a VM in this workflow.
`WorkerPool`	`setDefaultPackageSet(java.lang.String defaultPackageSet)` The default package set to install.
`WorkerPool`	`setDiskSizeGb(java.lang.Integer diskSizeGb)` Size of root disk for VMs, in GB.
`WorkerPool`	`setDiskSourceImage(java.lang.String diskSourceImage)` Fully qualified source image for disks.
`WorkerPool`	`setDiskType(java.lang.String diskType)` Type of root disk for VMs.
`WorkerPool`	`setIpConfiguration(java.lang.String ipConfiguration)` Configuration for VM IPs.
`WorkerPool`	`setKind(java.lang.String kind)` The kind of the worker pool; currently only `harness` and `shuffle` are supported.
`WorkerPool`	`setMachineType(java.lang.String machineType)` Machine type (e.g.
`WorkerPool`	`setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)` Metadata to set on the Google Compute Engine VMs.
`WorkerPool`	`setNetwork(java.lang.String network)` Network to which VMs will be assigned.
`WorkerPool`	`setNumThreadsPerWorker(java.lang.Integer numThreadsPerWorker)` The number of threads per worker harness.
`WorkerPool`	`setNumWorkers(java.lang.Integer numWorkers)` Number of Google Compute Engine workers in this pool needed to execute the job.
`WorkerPool`	`setOnHostMaintenance(java.lang.String onHostMaintenance)` The action to take on host maintenance, as defined by the Google Compute Engine API.
`WorkerPool`	`setPackages(java.util.List<DataflowPackage> packages)` Packages to be installed on workers.
`WorkerPool`	`setPoolArgs(java.util.Map<java.lang.String,java.lang.Object> poolArgs)` Extra arguments for this worker pool.
`WorkerPool`	`setSubnetwork(java.lang.String subnetwork)` Subnetwork to which VMs will be assigned, if desired.
`WorkerPool`	`setTaskrunnerSettings(TaskRunnerSettings taskrunnerSettings)` Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner.
`WorkerPool`	`setTeardownPolicy(java.lang.String teardownPolicy)` Sets the policy for determining when to turndown worker pool.
`WorkerPool`	`setWorkerHarnessContainerImage(java.lang.String workerHarnessContainerImage)` Required.
`WorkerPool`	`setZone(java.lang.String zone)` Zone to run the worker pools in.

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

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

- Constructor Detail
  - WorkerPool
```
public WorkerPool()
```
- Method Detail
  - getAutoscalingSettings
```
public AutoscalingSettings getAutoscalingSettings()
```
    Settings for autoscaling of this WorkerPool.
    
    Returns:
    
    value or null for none
  - setAutoscalingSettings
```
public WorkerPool setAutoscalingSettings(AutoscalingSettings autoscalingSettings)
```
    Settings for autoscaling of this WorkerPool.
    
    Parameters:
    
    autoscalingSettings - autoscalingSettings or null for none
  - getDataDisks
```
public java.util.List<Disk> getDataDisks()
```
    Data disks that are used by a VM in this workflow.
    
    Returns:
    
    value or null for none
  - setDataDisks
```
public WorkerPool setDataDisks(java.util.List<Disk> dataDisks)
```
    Data disks that are used by a VM in this workflow.
    
    Parameters:
    
    dataDisks - dataDisks or null for none
  - getDefaultPackageSet
```
public java.lang.String getDefaultPackageSet()
```
    The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language.
    
    Returns:
    
    value or null for none
  - setDefaultPackageSet
```
public WorkerPool setDefaultPackageSet(java.lang.String defaultPackageSet)
```
    The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language.
    
    Parameters:
    
    defaultPackageSet - defaultPackageSet or null for none
  - getDiskSizeGb
```
public java.lang.Integer getDiskSizeGb()
```
    Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default.
    
    Returns:
    
    value or null for none
  - setDiskSizeGb
```
public WorkerPool setDiskSizeGb(java.lang.Integer diskSizeGb)
```
    Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default.
    
    Parameters:
    
    diskSizeGb - diskSizeGb or null for none
  - getDiskSourceImage
```
public java.lang.String getDiskSourceImage()
```
    Fully qualified source image for disks.
    
    Returns:
    
    value or null for none
  - setDiskSourceImage
```
public WorkerPool setDiskSourceImage(java.lang.String diskSourceImage)
```
    Fully qualified source image for disks.
    
    Parameters:
    
    diskSourceImage - diskSourceImage or null for none
  - getDiskType
```
public java.lang.String getDiskType()
```
    Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default.
    
    Returns:
    
    value or null for none
  - setDiskType
```
public WorkerPool setDiskType(java.lang.String diskType)
```
    Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default.
    
    Parameters:
    
    diskType - diskType or null for none
  - getIpConfiguration
```
public java.lang.String getIpConfiguration()
```
    Configuration for VM IPs.
    
    Returns:
    
    value or null for none
  - setIpConfiguration
```
public WorkerPool setIpConfiguration(java.lang.String ipConfiguration)
```
    Configuration for VM IPs.
    
    Parameters:
    
    ipConfiguration - ipConfiguration or null for none
  - getKind
```
public java.lang.String getKind()
```
    The kind of the worker pool; currently only `harness` and `shuffle` are supported.
    
    Returns:
    
    value or null for none
  - setKind
```
public WorkerPool setKind(java.lang.String kind)
```
    The kind of the worker pool; currently only `harness` and `shuffle` are supported.
    
    Parameters:
    
    kind - kind or null for none
  - getMachineType
```
public java.lang.String getMachineType()
```
    Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default.
    
    Returns:
    
    value or null for none
  - setMachineType
```
public WorkerPool setMachineType(java.lang.String machineType)
```
    Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default.
    
    Parameters:
    
    machineType - machineType or null for none
  - getMetadata
```
public java.util.Map<java.lang.String,java.lang.String> getMetadata()
```
    Metadata to set on the Google Compute Engine VMs.
    
    Returns:
    
    value or null for none
  - setMetadata
```
public WorkerPool setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
```
    Metadata to set on the Google Compute Engine VMs.
    
    Parameters:
    
    metadata - metadata 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 WorkerPool 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
  - getNumThreadsPerWorker
```
public java.lang.Integer getNumThreadsPerWorker()
```
    The number of threads per worker harness. If empty or unspecified, the service will choose a number of threads (according to the number of cores on the selected machine type for batch, or 1 by convention for streaming).
    
    Returns:
    
    value or null for none
  - setNumThreadsPerWorker
```
public WorkerPool setNumThreadsPerWorker(java.lang.Integer numThreadsPerWorker)
```
    The number of threads per worker harness. If empty or unspecified, the service will choose a number of threads (according to the number of cores on the selected machine type for batch, or 1 by convention for streaming).
    
    Parameters:
    
    numThreadsPerWorker - numThreadsPerWorker or null for none
  - getNumWorkers
```
public java.lang.Integer getNumWorkers()
```
    Number of Google Compute Engine workers in this pool needed to execute the job. If zero or unspecified, the service will attempt to choose a reasonable default.
    
    Returns:
    
    value or null for none
  - setNumWorkers
```
public WorkerPool setNumWorkers(java.lang.Integer numWorkers)
```
    Number of Google Compute Engine workers in this pool needed to execute the job. If zero or unspecified, the service will attempt to choose a reasonable default.
    
    Parameters:
    
    numWorkers - numWorkers or null for none
  - getOnHostMaintenance
```
public java.lang.String getOnHostMaintenance()
```
    The action to take on host maintenance, as defined by the Google Compute Engine API.
    
    Returns:
    
    value or null for none
  - setOnHostMaintenance
```
public WorkerPool setOnHostMaintenance(java.lang.String onHostMaintenance)
```
    The action to take on host maintenance, as defined by the Google Compute Engine API.
    
    Parameters:
    
    onHostMaintenance - onHostMaintenance or null for none
  - getPackages
```
public java.util.List<DataflowPackage> getPackages()
```
    Packages to be installed on workers.
    
    Returns:
    
    value or null for none
  - setPackages
```
public WorkerPool setPackages(java.util.List<DataflowPackage> packages)
```
    Packages to be installed on workers.
    
    Parameters:
    
    packages - packages or null for none
  - getPoolArgs
```
public java.util.Map<java.lang.String,java.lang.Object> getPoolArgs()
```
    Extra arguments for this worker pool.
    
    Returns:
    
    value or null for none
  - setPoolArgs
```
public WorkerPool setPoolArgs(java.util.Map<java.lang.String,java.lang.Object> poolArgs)
```
    Extra arguments for this worker pool.
    
    Parameters:
    
    poolArgs - poolArgs 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 WorkerPool 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
  - getTaskrunnerSettings
```
public TaskRunnerSettings getTaskrunnerSettings()
```
    Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.
    
    Returns:
    
    value or null for none
  - setTaskrunnerSettings
```
public WorkerPool setTaskrunnerSettings(TaskRunnerSettings taskrunnerSettings)
```
    Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.
    
    Parameters:
    
    taskrunnerSettings - taskrunnerSettings or null for none
  - getTeardownPolicy
```
public java.lang.String getTeardownPolicy()
```
    Sets the policy for determining when to turndown worker pool. Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and `TEARDOWN_NEVER`. `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn down. If the workers are not torn down by the service, they will continue to run and use Google Compute Engine VM resources in the user's project until they are explicitly terminated by the user. Because of this, Google recommends using the `TEARDOWN_ALWAYS` policy except for small, manually supervised test jobs. If unknown or unspecified, the service will attempt to choose a reasonable default.
    
    Returns:
    
    value or null for none
  - setTeardownPolicy
```
public WorkerPool setTeardownPolicy(java.lang.String teardownPolicy)
```
    Sets the policy for determining when to turndown worker pool. Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and `TEARDOWN_NEVER`. `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn down. If the workers are not torn down by the service, they will continue to run and use Google Compute Engine VM resources in the user's project until they are explicitly terminated by the user. Because of this, Google recommends using the `TEARDOWN_ALWAYS` policy except for small, manually supervised test jobs. If unknown or unspecified, the service will attempt to choose a reasonable default.
    
    Parameters:
    
    teardownPolicy - teardownPolicy or null for none
  - getWorkerHarnessContainerImage
```
public java.lang.String getWorkerHarnessContainerImage()
```
    Required. Docker container image that executes the Cloud Dataflow worker harness, residing in Google Container Registry.
    
    Returns:
    
    value or null for none
  - setWorkerHarnessContainerImage
```
public WorkerPool setWorkerHarnessContainerImage(java.lang.String workerHarnessContainerImage)
```
    Required. Docker container image that executes the Cloud Dataflow worker harness, residing in Google Container Registry.
    
    Parameters:
    
    workerHarnessContainerImage - workerHarnessContainerImage or null for none
  - getZone
```
public java.lang.String getZone()
```
    Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default.
    
    Returns:
    
    value or null for none
  - setZone
```
public WorkerPool setZone(java.lang.String zone)
```
    Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default.
    
    Parameters:
    
    zone - zone or null for none
  - set
```
public WorkerPool set(java.lang.String fieldName,
                      java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public WorkerPool clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Dataflow API v1b3 (revision 278)

Class WorkerPool

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

WorkerPool

Method Detail

getAutoscalingSettings

setAutoscalingSettings

getDataDisks

setDataDisks

getDefaultPackageSet

setDefaultPackageSet

getDiskSizeGb

setDiskSizeGb

getDiskSourceImage

setDiskSourceImage

getDiskType

setDiskType

getIpConfiguration

setIpConfiguration

getKind

setKind

getMachineType

setMachineType

getMetadata

setMetadata

getNetwork

setNetwork

getNumThreadsPerWorker

setNumThreadsPerWorker

getNumWorkers

setNumWorkers

getOnHostMaintenance

setOnHostMaintenance

getPackages

setPackages

getPoolArgs

setPoolArgs

getSubnetwork

setSubnetwork

getTaskrunnerSettings

setTaskrunnerSettings

getTeardownPolicy

setTeardownPolicy

getWorkerHarnessContainerImage

setWorkerHarnessContainerImage

getZone

setZone

set

clone