Class WorkerPool.Builder (0.52.0) 

public static final class WorkerPool.Builder extends GeneratedMessageV3.Builder<WorkerPool.Builder> implements WorkerPoolOrBuilder

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.

Protobuf type google.dataflow.v1beta3.WorkerPool

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > WorkerPool.Builder

Implements

WorkerPoolOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllDataDisks(Iterable<? extends Disk> values)

public WorkerPool.Builder addAllDataDisks(Iterable<? extends Disk> values)

Data disks that are used by a VM in this workflow.

repeated .google.dataflow.v1beta3.Disk data_disks = 12;

Parameter
Name Description
values Iterable<? extends com.google.dataflow.v1beta3.Disk>
Returns
Type Description
WorkerPool.Builder

addAllPackages(Iterable<? extends Package> values)

public WorkerPool.Builder addAllPackages(Iterable<? extends Package> values)

Packages to be installed on workers.

repeated .google.dataflow.v1beta3.Package packages = 3;

Parameter
Name Description
values Iterable<? extends com.google.dataflow.v1beta3.Package>
Returns
Type Description
WorkerPool.Builder

addAllSdkHarnessContainerImages(Iterable<? extends SdkHarnessContainerImage> values)

public WorkerPool.Builder addAllSdkHarnessContainerImages(Iterable<? extends SdkHarnessContainerImage> values)

Set of SDK harness containers needed to execute this pipeline. This will only be set in the Fn API path. For non-cross-language pipelines this should have only one entry. Cross-language pipelines will have two or more entries.

repeated .google.dataflow.v1beta3.SdkHarnessContainerImage sdk_harness_container_images = 22;

Parameter
Name Description
values Iterable<? extends com.google.dataflow.v1beta3.SdkHarnessContainerImage>
Returns
Type Description
WorkerPool.Builder

addDataDisks(Disk value)

public WorkerPool.Builder addDataDisks(Disk value)

Data disks that are used by a VM in this workflow.

repeated .google.dataflow.v1beta3.Disk data_disks = 12;

Parameter
Name Description
value Disk
Returns
Type Description
WorkerPool.Builder

addDataDisks(Disk.Builder builderForValue)

public WorkerPool.Builder addDataDisks(Disk.Builder builderForValue)

Data disks that are used by a VM in this workflow.

repeated .google.dataflow.v1beta3.Disk data_disks = 12;

Parameter
Name Description
builderForValue Disk.Builder
Returns
Type Description
WorkerPool.Builder

addDataDisks(int index, Disk value)

public WorkerPool.Builder addDataDisks(int index, Disk value)

Data disks that are used by a VM in this workflow.

repeated .google.dataflow.v1beta3.Disk data_disks = 12;

Parameters
Name Description
index int
value Disk
Returns
Type Description
WorkerPool.Builder

addDataDisks(int index, Disk.Builder builderForValue)

public WorkerPool.Builder addDataDisks(int index, Disk.Builder builderForValue)

Data disks that are used by a VM in this workflow.

repeated .google.dataflow.v1beta3.Disk data_disks = 12;

Parameters
Name Description
index int
builderForValue Disk.Builder
Returns
Type Description
WorkerPool.Builder

addDataDisksBuilder()

public Disk.Builder addDataDisksBuilder()

Data disks that are used by a VM in this workflow.

repeated .google.dataflow.v1beta3.Disk data_disks = 12;

Returns
Type Description
Disk.Builder

addDataDisksBuilder(int index)

public Disk.Builder addDataDisksBuilder(int index)

Data disks that are used by a VM in this workflow.

repeated .google.dataflow.v1beta3.Disk data_disks = 12;

Parameter
Name Description
index int
Returns
Type Description
Disk.Builder

addPackages(Package value)

public WorkerPool.Builder addPackages(Package value)

Packages to be installed on workers.

repeated .google.dataflow.v1beta3.Package packages = 3;

Parameter
Name Description
value Package
Returns
Type Description
WorkerPool.Builder

addPackages(Package.Builder builderForValue)

public WorkerPool.Builder addPackages(Package.Builder builderForValue)

Packages to be installed on workers.

repeated .google.dataflow.v1beta3.Package packages = 3;

Parameter
Name Description
builderForValue Package.Builder
Returns
Type Description
WorkerPool.Builder

addPackages(int index, Package value)

public WorkerPool.Builder addPackages(int index, Package value)

Packages to be installed on workers.

repeated .google.dataflow.v1beta3.Package packages = 3;

Parameters
Name Description
index int
value Package
Returns
Type Description
WorkerPool.Builder

addPackages(int index, Package.Builder builderForValue)

public WorkerPool.Builder addPackages(int index, Package.Builder builderForValue)

Packages to be installed on workers.

repeated .google.dataflow.v1beta3.Package packages = 3;

Parameters
Name Description
index int
builderForValue Package.Builder
Returns
Type Description
WorkerPool.Builder

addPackagesBuilder()

public Package.Builder addPackagesBuilder()

Packages to be installed on workers.

repeated .google.dataflow.v1beta3.Package packages = 3;

Returns
Type Description
Package.Builder

addPackagesBuilder(int index)

public Package.Builder addPackagesBuilder(int index)

Packages to be installed on workers.

repeated .google.dataflow.v1beta3.Package packages = 3;

Parameter
Name Description
index int
Returns
Type Description
Package.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public WorkerPool.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
WorkerPool.Builder
Overrides

addSdkHarnessContainerImages(SdkHarnessContainerImage value)

public WorkerPool.Builder addSdkHarnessContainerImages(SdkHarnessContainerImage value)

Set of SDK harness containers needed to execute this pipeline. This will only be set in the Fn API path. For non-cross-language pipelines this should have only one entry. Cross-language pipelines will have two or more entries.

repeated .google.dataflow.v1beta3.SdkHarnessContainerImage sdk_harness_container_images = 22;

Parameter
Name Description
value SdkHarnessContainerImage
Returns
Type Description
WorkerPool.Builder

addSdkHarnessContainerImages(SdkHarnessContainerImage.Builder builderForValue)

public WorkerPool.Builder addSdkHarnessContainerImages(SdkHarnessContainerImage.Builder builderForValue)

Set of SDK harness containers needed to execute this pipeline. This will only be set in the Fn API path. For non-cross-language pipelines this should have only one entry. Cross-language pipelines will have two or more entries.

repeated .google.dataflow.v1beta3.SdkHarnessContainerImage sdk_harness_container_images = 22;

Parameter
Name Description
builderForValue SdkHarnessContainerImage.Builder
Returns
Type Description
WorkerPool.Builder

addSdkHarnessContainerImages(int index, SdkHarnessContainerImage value)

public WorkerPool.Builder addSdkHarnessContainerImages(int index, SdkHarnessContainerImage value)

Set of SDK harness containers needed to execute this pipeline. This will only be set in the Fn API path. For non-cross-language pipelines this should have only one entry. Cross-language pipelines will have two or more entries.

repeated .google.dataflow.v1beta3.SdkHarnessContainerImage sdk_harness_container_images = 22;

Parameters
Name Description
index int
value SdkHarnessContainerImage
Returns
Type Description
WorkerPool.Builder

addSdkHarnessContainerImages(int index, SdkHarnessContainerImage.Builder builderForValue)

public WorkerPool.Builder addSdkHarnessContainerImages(int index, SdkHarnessContainerImage.Builder builderForValue)

Set of SDK harness containers needed to execute this pipeline. This will only be set in the Fn API path. For non-cross-language pipelines this should have only one entry. Cross-language pipelines will have two or more entries.

repeated .google.dataflow.v1beta3.SdkHarnessContainerImage sdk_harness_container_images = 22;

Parameters
Name Description
index int
builderForValue SdkHarnessContainerImage.Builder
Returns
Type Description
WorkerPool.Builder

addSdkHarnessContainerImagesBuilder()

public SdkHarnessContainerImage.Builder addSdkHarnessContainerImagesBuilder()

Set of SDK harness containers needed to execute this pipeline. This will only be set in the Fn API path. For non-cross-language pipelines this should have only one entry. Cross-language pipelines will have two or more entries.

repeated .google.dataflow.v1beta3.SdkHarnessContainerImage sdk_harness_container_images = 22;

Returns
Type Description
SdkHarnessContainerImage.Builder

addSdkHarnessContainerImagesBuilder(int index)

public SdkHarnessContainerImage.Builder addSdkHarnessContainerImagesBuilder(int index)

Set of SDK harness containers needed to execute this pipeline. This will only be set in the Fn API path. For non-cross-language pipelines this should have only one entry. Cross-language pipelines will have two or more entries.

repeated .google.dataflow.v1beta3.SdkHarnessContainerImage sdk_harness_container_images = 22;

Parameter
Name Description
index int
Returns
Type Description
SdkHarnessContainerImage.Builder

build()

public WorkerPool build()
Returns
Type Description
WorkerPool

buildPartial()

public WorkerPool buildPartial()
Returns
Type Description
WorkerPool

clear()

public WorkerPool.Builder clear()
Returns
Type Description
WorkerPool.Builder
Overrides

clearAutoscalingSettings()

public WorkerPool.Builder clearAutoscalingSettings()

Settings for autoscaling of this WorkerPool.

.google.dataflow.v1beta3.AutoscalingSettings autoscaling_settings = 14;

Returns
Type Description
WorkerPool.Builder

clearDataDisks()

public WorkerPool.Builder clearDataDisks()

Data disks that are used by a VM in this workflow.

repeated .google.dataflow.v1beta3.Disk data_disks = 12;

Returns
Type Description
WorkerPool.Builder

clearDefaultPackageSet()

public WorkerPool.Builder clearDefaultPackageSet()

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.

.google.dataflow.v1beta3.DefaultPackageSet default_package_set = 4;

Returns
Type Description
WorkerPool.Builder

This builder for chaining.

clearDiskSizeGb()

public WorkerPool.Builder clearDiskSizeGb()

Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default.

int32 disk_size_gb = 7;

Returns
Type Description
WorkerPool.Builder

This builder for chaining.

clearDiskSourceImage()

public WorkerPool.Builder clearDiskSourceImage()

Fully qualified source image for disks.

string disk_source_image = 8;

Returns
Type Description
WorkerPool.Builder

This builder for chaining.

clearDiskType()

public WorkerPool.Builder clearDiskType()

Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default.

string disk_type = 16;

Returns
Type Description
WorkerPool.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public WorkerPool.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
WorkerPool.Builder
Overrides

clearIpConfiguration()

public WorkerPool.Builder clearIpConfiguration()

Configuration for VM IPs.

.google.dataflow.v1beta3.WorkerIPAddressConfiguration ip_configuration = 21;

Returns
Type Description
WorkerPool.Builder

This builder for chaining.

clearKind()

public WorkerPool.Builder clearKind()

The kind of the worker pool; currently only harness and shuffle are supported.

string kind = 1;

Returns
Type Description
WorkerPool.Builder

This builder for chaining.

clearMachineType()

public WorkerPool.Builder clearMachineType()

Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default.

string machine_type = 5;

Returns
Type Description
WorkerPool.Builder

This builder for chaining.

clearMetadata()

public WorkerPool.Builder clearMetadata()
Returns
Type Description
WorkerPool.Builder

clearNetwork()

public WorkerPool.Builder clearNetwork()

Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".

string network = 17;

Returns
Type Description
WorkerPool.Builder

This builder for chaining.

clearNumThreadsPerWorker()

public WorkerPool.Builder clearNumThreadsPerWorker()

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

int32 num_threads_per_worker = 20;

Returns
Type Description
WorkerPool.Builder

This builder for chaining.

clearNumWorkers()

public WorkerPool.Builder clearNumWorkers()

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.

int32 num_workers = 2;

Returns
Type Description
WorkerPool.Builder

This builder for chaining.

clearOnHostMaintenance()

public WorkerPool.Builder clearOnHostMaintenance()

The action to take on host maintenance, as defined by the Google Compute Engine API.

string on_host_maintenance = 11;

Returns
Type Description
WorkerPool.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public WorkerPool.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
WorkerPool.Builder
Overrides

clearPackages()

public WorkerPool.Builder clearPackages()

Packages to be installed on workers.

repeated .google.dataflow.v1beta3.Package packages = 3;

Returns
Type Description
WorkerPool.Builder

clearPoolArgs()

public WorkerPool.Builder clearPoolArgs()

Extra arguments for this worker pool.

.google.protobuf.Any pool_args = 15;

Returns
Type Description
WorkerPool.Builder

clearSdkHarnessContainerImages()

public WorkerPool.Builder clearSdkHarnessContainerImages()

Set of SDK harness containers needed to execute this pipeline. This will only be set in the Fn API path. For non-cross-language pipelines this should have only one entry. Cross-language pipelines will have two or more entries.

repeated .google.dataflow.v1beta3.SdkHarnessContainerImage sdk_harness_container_images = 22;

Returns
Type Description
WorkerPool.Builder

clearSubnetwork()

public WorkerPool.Builder clearSubnetwork()

Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK".

string subnetwork = 19;

Returns
Type Description
WorkerPool.Builder

This builder for chaining.

clearTaskrunnerSettings()

public WorkerPool.Builder clearTaskrunnerSettings()

Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.

.google.dataflow.v1beta3.TaskRunnerSettings taskrunner_settings = 10;

Returns
Type Description
WorkerPool.Builder

clearTeardownPolicy()

public WorkerPool.Builder clearTeardownPolicy()

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.

.google.dataflow.v1beta3.TeardownPolicy teardown_policy = 6;

Returns
Type Description
WorkerPool.Builder

This builder for chaining.

clearWorkerHarnessContainerImage()

public WorkerPool.Builder clearWorkerHarnessContainerImage()

Required. Docker container image that executes the Cloud Dataflow worker harness, residing in Google Container Registry.

Deprecated for the Fn API path. Use sdk_harness_container_images instead.

string worker_harness_container_image = 18;

Returns
Type Description
WorkerPool.Builder

This builder for chaining.

clearZone()

public WorkerPool.Builder clearZone()

Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default.

string zone = 9;

Returns
Type Description
WorkerPool.Builder

This builder for chaining.

clone()

public WorkerPool.Builder clone()
Returns
Type Description
WorkerPool.Builder
Overrides

containsMetadata(String key)

public boolean containsMetadata(String key)

Metadata to set on the Google Compute Engine VMs.

map<string, string> metadata = 13;

Parameter
Name Description
key String
Returns
Type Description
boolean

getAutoscalingSettings()

public AutoscalingSettings getAutoscalingSettings()

Settings for autoscaling of this WorkerPool.

.google.dataflow.v1beta3.AutoscalingSettings autoscaling_settings = 14;

Returns
Type Description
AutoscalingSettings

The autoscalingSettings.

getAutoscalingSettingsBuilder()

public AutoscalingSettings.Builder getAutoscalingSettingsBuilder()

Settings for autoscaling of this WorkerPool.

.google.dataflow.v1beta3.AutoscalingSettings autoscaling_settings = 14;

Returns
Type Description
AutoscalingSettings.Builder

getAutoscalingSettingsOrBuilder()

public AutoscalingSettingsOrBuilder getAutoscalingSettingsOrBuilder()

Settings for autoscaling of this WorkerPool.

.google.dataflow.v1beta3.AutoscalingSettings autoscaling_settings = 14;

Returns
Type Description
AutoscalingSettingsOrBuilder

getDataDisks(int index)

public Disk getDataDisks(int index)

Data disks that are used by a VM in this workflow.

repeated .google.dataflow.v1beta3.Disk data_disks = 12;

Parameter
Name Description
index int
Returns
Type Description
Disk

getDataDisksBuilder(int index)

public Disk.Builder getDataDisksBuilder(int index)

Data disks that are used by a VM in this workflow.

repeated .google.dataflow.v1beta3.Disk data_disks = 12;

Parameter
Name Description
index int
Returns
Type Description
Disk.Builder

getDataDisksBuilderList()

public List<Disk.Builder> getDataDisksBuilderList()

Data disks that are used by a VM in this workflow.

repeated .google.dataflow.v1beta3.Disk data_disks = 12;

Returns
Type Description
List<Builder>

getDataDisksCount()

public int getDataDisksCount()

Data disks that are used by a VM in this workflow.

repeated .google.dataflow.v1beta3.Disk data_disks = 12;

Returns
Type Description
int

getDataDisksList()

public List<Disk> getDataDisksList()

Data disks that are used by a VM in this workflow.

repeated .google.dataflow.v1beta3.Disk data_disks = 12;

Returns
Type Description
List<Disk>

getDataDisksOrBuilder(int index)

public DiskOrBuilder getDataDisksOrBuilder(int index)

Data disks that are used by a VM in this workflow.

repeated .google.dataflow.v1beta3.Disk data_disks = 12;

Parameter
Name Description
index int
Returns
Type Description
DiskOrBuilder

getDataDisksOrBuilderList()

public List<? extends DiskOrBuilder> getDataDisksOrBuilderList()

Data disks that are used by a VM in this workflow.

repeated .google.dataflow.v1beta3.Disk data_disks = 12;

Returns
Type Description
List<? extends com.google.dataflow.v1beta3.DiskOrBuilder>

getDefaultInstanceForType()

public WorkerPool getDefaultInstanceForType()
Returns
Type Description
WorkerPool

getDefaultPackageSet()

public DefaultPackageSet 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.

.google.dataflow.v1beta3.DefaultPackageSet default_package_set = 4;

Returns
Type Description
DefaultPackageSet

The defaultPackageSet.

getDefaultPackageSetValue()

public int getDefaultPackageSetValue()

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.

.google.dataflow.v1beta3.DefaultPackageSet default_package_set = 4;

Returns
Type Description
int

The enum numeric value on the wire for defaultPackageSet.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDiskSizeGb()

public int getDiskSizeGb()

Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default.

int32 disk_size_gb = 7;

Returns
Type Description
int

The diskSizeGb.

getDiskSourceImage()

public String getDiskSourceImage()

Fully qualified source image for disks.

string disk_source_image = 8;

Returns
Type Description
String

The diskSourceImage.

getDiskSourceImageBytes()

public ByteString getDiskSourceImageBytes()

Fully qualified source image for disks.

string disk_source_image = 8;

Returns
Type Description
ByteString

The bytes for diskSourceImage.

getDiskType()

public String getDiskType()

Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default.

string disk_type = 16;

Returns
Type Description
String

The diskType.

getDiskTypeBytes()

public ByteString getDiskTypeBytes()

Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default.

string disk_type = 16;

Returns
Type Description
ByteString

The bytes for diskType.

getIpConfiguration()

public WorkerIPAddressConfiguration getIpConfiguration()

Configuration for VM IPs.

.google.dataflow.v1beta3.WorkerIPAddressConfiguration ip_configuration = 21;

Returns
Type Description
WorkerIPAddressConfiguration

The ipConfiguration.

getIpConfigurationValue()

public int getIpConfigurationValue()

Configuration for VM IPs.

.google.dataflow.v1beta3.WorkerIPAddressConfiguration ip_configuration = 21;

Returns
Type Description
int

The enum numeric value on the wire for ipConfiguration.

getKind()

public String getKind()

The kind of the worker pool; currently only harness and shuffle are supported.

string kind = 1;

Returns
Type Description
String

The kind.

getKindBytes()

public ByteString getKindBytes()

The kind of the worker pool; currently only harness and shuffle are supported.

string kind = 1;

Returns
Type Description
ByteString

The bytes for kind.

getMachineType()

public String getMachineType()

Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default.

string machine_type = 5;

Returns
Type Description
String

The machineType.

getMachineTypeBytes()

public ByteString getMachineTypeBytes()

Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default.

string machine_type = 5;

Returns
Type Description
ByteString

The bytes for machineType.

getMetadata() (deprecated)

public Map<String,String> getMetadata()

Use #getMetadataMap() instead.

Returns
Type Description
Map<String,String>

getMetadataCount()

public int getMetadataCount()

Metadata to set on the Google Compute Engine VMs.

map<string, string> metadata = 13;

Returns
Type Description
int

getMetadataMap()

public Map<String,String> getMetadataMap()

Metadata to set on the Google Compute Engine VMs.

map<string, string> metadata = 13;

Returns
Type Description
Map<String,String>

getMetadataOrDefault(String key, String defaultValue)

public String getMetadataOrDefault(String key, String defaultValue)

Metadata to set on the Google Compute Engine VMs.

map<string, string> metadata = 13;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getMetadataOrThrow(String key)

public String getMetadataOrThrow(String key)

Metadata to set on the Google Compute Engine VMs.

map<string, string> metadata = 13;

Parameter
Name Description
key String
Returns
Type Description
String

getMutableMetadata() (deprecated)

public Map<String,String> getMutableMetadata()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getNetwork()

public String getNetwork()

Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".

string network = 17;

Returns
Type Description
String

The network.

getNetworkBytes()

public ByteString getNetworkBytes()

Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".

string network = 17;

Returns
Type Description
ByteString

The bytes for network.

getNumThreadsPerWorker()

public int 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).

int32 num_threads_per_worker = 20;

Returns
Type Description
int

The numThreadsPerWorker.

getNumWorkers()

public int 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.

int32 num_workers = 2;

Returns
Type Description
int

The numWorkers.

getOnHostMaintenance()

public String getOnHostMaintenance()

The action to take on host maintenance, as defined by the Google Compute Engine API.

string on_host_maintenance = 11;

Returns
Type Description
String

The onHostMaintenance.

getOnHostMaintenanceBytes()

public ByteString getOnHostMaintenanceBytes()

The action to take on host maintenance, as defined by the Google Compute Engine API.

string on_host_maintenance = 11;

Returns
Type Description
ByteString

The bytes for onHostMaintenance.

getPackages(int index)

public Package getPackages(int index)

Packages to be installed on workers.

repeated .google.dataflow.v1beta3.Package packages = 3;

Parameter
Name Description
index int
Returns
Type Description
Package

getPackagesBuilder(int index)

public Package.Builder getPackagesBuilder(int index)

Packages to be installed on workers.

repeated .google.dataflow.v1beta3.Package packages = 3;

Parameter
Name Description
index int
Returns
Type Description
Package.Builder

getPackagesBuilderList()

public List<Package.Builder> getPackagesBuilderList()

Packages to be installed on workers.

repeated .google.dataflow.v1beta3.Package packages = 3;

Returns
Type Description
List<Builder>

getPackagesCount()

public int getPackagesCount()

Packages to be installed on workers.

repeated .google.dataflow.v1beta3.Package packages = 3;

Returns
Type Description
int

getPackagesList()

public List<Package> getPackagesList()

Packages to be installed on workers.

repeated .google.dataflow.v1beta3.Package packages = 3;

Returns
Type Description
List<Package>

getPackagesOrBuilder(int index)

public PackageOrBuilder getPackagesOrBuilder(int index)

Packages to be installed on workers.

repeated .google.dataflow.v1beta3.Package packages = 3;

Parameter
Name Description
index int
Returns
Type Description
PackageOrBuilder

getPackagesOrBuilderList()

public List<? extends PackageOrBuilder> getPackagesOrBuilderList()

Packages to be installed on workers.

repeated .google.dataflow.v1beta3.Package packages = 3;

Returns
Type Description
List<? extends com.google.dataflow.v1beta3.PackageOrBuilder>

getPoolArgs()

public Any getPoolArgs()

Extra arguments for this worker pool.

.google.protobuf.Any pool_args = 15;

Returns
Type Description
Any

The poolArgs.

getPoolArgsBuilder()

public Any.Builder getPoolArgsBuilder()

Extra arguments for this worker pool.

.google.protobuf.Any pool_args = 15;

Returns
Type Description
Builder

getPoolArgsOrBuilder()

public AnyOrBuilder getPoolArgsOrBuilder()

Extra arguments for this worker pool.

.google.protobuf.Any pool_args = 15;

Returns
Type Description
AnyOrBuilder

getSdkHarnessContainerImages(int index)

public SdkHarnessContainerImage getSdkHarnessContainerImages(int index)

Set of SDK harness containers needed to execute this pipeline. This will only be set in the Fn API path. For non-cross-language pipelines this should have only one entry. Cross-language pipelines will have two or more entries.

repeated .google.dataflow.v1beta3.SdkHarnessContainerImage sdk_harness_container_images = 22;

Parameter
Name Description
index int
Returns
Type Description
SdkHarnessContainerImage

getSdkHarnessContainerImagesBuilder(int index)

public SdkHarnessContainerImage.Builder getSdkHarnessContainerImagesBuilder(int index)

Set of SDK harness containers needed to execute this pipeline. This will only be set in the Fn API path. For non-cross-language pipelines this should have only one entry. Cross-language pipelines will have two or more entries.

repeated .google.dataflow.v1beta3.SdkHarnessContainerImage sdk_harness_container_images = 22;

Parameter
Name Description
index int
Returns
Type Description
SdkHarnessContainerImage.Builder

getSdkHarnessContainerImagesBuilderList()

public List<SdkHarnessContainerImage.Builder> getSdkHarnessContainerImagesBuilderList()

Set of SDK harness containers needed to execute this pipeline. This will only be set in the Fn API path. For non-cross-language pipelines this should have only one entry. Cross-language pipelines will have two or more entries.

repeated .google.dataflow.v1beta3.SdkHarnessContainerImage sdk_harness_container_images = 22;

Returns
Type Description
List<Builder>

getSdkHarnessContainerImagesCount()

public int getSdkHarnessContainerImagesCount()

Set of SDK harness containers needed to execute this pipeline. This will only be set in the Fn API path. For non-cross-language pipelines this should have only one entry. Cross-language pipelines will have two or more entries.

repeated .google.dataflow.v1beta3.SdkHarnessContainerImage sdk_harness_container_images = 22;

Returns
Type Description
int

getSdkHarnessContainerImagesList()

public List<SdkHarnessContainerImage> getSdkHarnessContainerImagesList()

Set of SDK harness containers needed to execute this pipeline. This will only be set in the Fn API path. For non-cross-language pipelines this should have only one entry. Cross-language pipelines will have two or more entries.

repeated .google.dataflow.v1beta3.SdkHarnessContainerImage sdk_harness_container_images = 22;

Returns
Type Description
List<SdkHarnessContainerImage>

getSdkHarnessContainerImagesOrBuilder(int index)

public SdkHarnessContainerImageOrBuilder getSdkHarnessContainerImagesOrBuilder(int index)

Set of SDK harness containers needed to execute this pipeline. This will only be set in the Fn API path. For non-cross-language pipelines this should have only one entry. Cross-language pipelines will have two or more entries.

repeated .google.dataflow.v1beta3.SdkHarnessContainerImage sdk_harness_container_images = 22;

Parameter
Name Description
index int
Returns
Type Description
SdkHarnessContainerImageOrBuilder

getSdkHarnessContainerImagesOrBuilderList()

public List<? extends SdkHarnessContainerImageOrBuilder> getSdkHarnessContainerImagesOrBuilderList()

Set of SDK harness containers needed to execute this pipeline. This will only be set in the Fn API path. For non-cross-language pipelines this should have only one entry. Cross-language pipelines will have two or more entries.

repeated .google.dataflow.v1beta3.SdkHarnessContainerImage sdk_harness_container_images = 22;

Returns
Type Description
List<? extends com.google.dataflow.v1beta3.SdkHarnessContainerImageOrBuilder>

getSubnetwork()

public String getSubnetwork()

Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK".

string subnetwork = 19;

Returns
Type Description
String

The subnetwork.

getSubnetworkBytes()

public ByteString getSubnetworkBytes()

Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK".

string subnetwork = 19;

Returns
Type Description
ByteString

The bytes for subnetwork.

getTaskrunnerSettings()

public TaskRunnerSettings getTaskrunnerSettings()

Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.

.google.dataflow.v1beta3.TaskRunnerSettings taskrunner_settings = 10;

Returns
Type Description
TaskRunnerSettings

The taskrunnerSettings.

getTaskrunnerSettingsBuilder()

public TaskRunnerSettings.Builder getTaskrunnerSettingsBuilder()

Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.

.google.dataflow.v1beta3.TaskRunnerSettings taskrunner_settings = 10;

Returns
Type Description
TaskRunnerSettings.Builder

getTaskrunnerSettingsOrBuilder()

public TaskRunnerSettingsOrBuilder getTaskrunnerSettingsOrBuilder()

Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.

.google.dataflow.v1beta3.TaskRunnerSettings taskrunner_settings = 10;

Returns
Type Description
TaskRunnerSettingsOrBuilder

getTeardownPolicy()

public TeardownPolicy 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.

.google.dataflow.v1beta3.TeardownPolicy teardown_policy = 6;

Returns
Type Description
TeardownPolicy

The teardownPolicy.

getTeardownPolicyValue()

public int getTeardownPolicyValue()

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.

.google.dataflow.v1beta3.TeardownPolicy teardown_policy = 6;

Returns
Type Description
int

The enum numeric value on the wire for teardownPolicy.

getWorkerHarnessContainerImage()

public String getWorkerHarnessContainerImage()

Required. Docker container image that executes the Cloud Dataflow worker harness, residing in Google Container Registry.

Deprecated for the Fn API path. Use sdk_harness_container_images instead.

string worker_harness_container_image = 18;

Returns
Type Description
String

The workerHarnessContainerImage.

getWorkerHarnessContainerImageBytes()

public ByteString getWorkerHarnessContainerImageBytes()

Required. Docker container image that executes the Cloud Dataflow worker harness, residing in Google Container Registry.

Deprecated for the Fn API path. Use sdk_harness_container_images instead.

string worker_harness_container_image = 18;

Returns
Type Description
ByteString

The bytes for workerHarnessContainerImage.

getZone()

public String getZone()

Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default.

string zone = 9;

Returns
Type Description
String

The zone.

getZoneBytes()

public ByteString getZoneBytes()

Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default.

string zone = 9;

Returns
Type Description
ByteString

The bytes for zone.

hasAutoscalingSettings()

public boolean hasAutoscalingSettings()

Settings for autoscaling of this WorkerPool.

.google.dataflow.v1beta3.AutoscalingSettings autoscaling_settings = 14;

Returns
Type Description
boolean

Whether the autoscalingSettings field is set.

hasPoolArgs()

public boolean hasPoolArgs()

Extra arguments for this worker pool.

.google.protobuf.Any pool_args = 15;

Returns
Type Description
boolean

Whether the poolArgs field is set.

hasTaskrunnerSettings()

public boolean hasTaskrunnerSettings()

Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.

.google.dataflow.v1beta3.TaskRunnerSettings taskrunner_settings = 10;

Returns
Type Description
boolean

Whether the taskrunnerSettings field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAutoscalingSettings(AutoscalingSettings value)

public WorkerPool.Builder mergeAutoscalingSettings(AutoscalingSettings value)

Settings for autoscaling of this WorkerPool.

.google.dataflow.v1beta3.AutoscalingSettings autoscaling_settings = 14;

Parameter
Name Description
value AutoscalingSettings
Returns
Type Description
WorkerPool.Builder

mergeFrom(WorkerPool other)

public WorkerPool.Builder mergeFrom(WorkerPool other)
Parameter
Name Description
other WorkerPool
Returns
Type Description
WorkerPool.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public WorkerPool.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WorkerPool.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public WorkerPool.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
WorkerPool.Builder
Overrides

mergePoolArgs(Any value)

public WorkerPool.Builder mergePoolArgs(Any value)

Extra arguments for this worker pool.

.google.protobuf.Any pool_args = 15;

Parameter
Name Description
value Any
Returns
Type Description
WorkerPool.Builder

mergeTaskrunnerSettings(TaskRunnerSettings value)

public WorkerPool.Builder mergeTaskrunnerSettings(TaskRunnerSettings value)

Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.

.google.dataflow.v1beta3.TaskRunnerSettings taskrunner_settings = 10;

Parameter
Name Description
value TaskRunnerSettings
Returns
Type Description
WorkerPool.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final WorkerPool.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
WorkerPool.Builder
Overrides

putAllMetadata(Map<String,String> values)

public WorkerPool.Builder putAllMetadata(Map<String,String> values)

Metadata to set on the Google Compute Engine VMs.

map<string, string> metadata = 13;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
WorkerPool.Builder

putMetadata(String key, String value)

public WorkerPool.Builder putMetadata(String key, String value)

Metadata to set on the Google Compute Engine VMs.

map<string, string> metadata = 13;

Parameters
Name Description
key String
value String
Returns
Type Description
WorkerPool.Builder

removeDataDisks(int index)

public WorkerPool.Builder removeDataDisks(int index)

Data disks that are used by a VM in this workflow.

repeated .google.dataflow.v1beta3.Disk data_disks = 12;

Parameter
Name Description
index int
Returns
Type Description
WorkerPool.Builder

removeMetadata(String key)

public WorkerPool.Builder removeMetadata(String key)

Metadata to set on the Google Compute Engine VMs.

map<string, string> metadata = 13;

Parameter
Name Description
key String
Returns
Type Description
WorkerPool.Builder

removePackages(int index)

public WorkerPool.Builder removePackages(int index)

Packages to be installed on workers.

repeated .google.dataflow.v1beta3.Package packages = 3;

Parameter
Name Description
index int
Returns
Type Description
WorkerPool.Builder

removeSdkHarnessContainerImages(int index)

public WorkerPool.Builder removeSdkHarnessContainerImages(int index)

Set of SDK harness containers needed to execute this pipeline. This will only be set in the Fn API path. For non-cross-language pipelines this should have only one entry. Cross-language pipelines will have two or more entries.

repeated .google.dataflow.v1beta3.SdkHarnessContainerImage sdk_harness_container_images = 22;

Parameter
Name Description
index int
Returns
Type Description
WorkerPool.Builder

setAutoscalingSettings(AutoscalingSettings value)

public WorkerPool.Builder setAutoscalingSettings(AutoscalingSettings value)

Settings for autoscaling of this WorkerPool.

.google.dataflow.v1beta3.AutoscalingSettings autoscaling_settings = 14;

Parameter
Name Description
value AutoscalingSettings
Returns
Type Description
WorkerPool.Builder

setAutoscalingSettings(AutoscalingSettings.Builder builderForValue)

public WorkerPool.Builder setAutoscalingSettings(AutoscalingSettings.Builder builderForValue)

Settings for autoscaling of this WorkerPool.

.google.dataflow.v1beta3.AutoscalingSettings autoscaling_settings = 14;

Parameter
Name Description
builderForValue AutoscalingSettings.Builder
Returns
Type Description
WorkerPool.Builder

setDataDisks(int index, Disk value)

public WorkerPool.Builder setDataDisks(int index, Disk value)

Data disks that are used by a VM in this workflow.

repeated .google.dataflow.v1beta3.Disk data_disks = 12;

Parameters
Name Description
index int
value Disk
Returns
Type Description
WorkerPool.Builder

setDataDisks(int index, Disk.Builder builderForValue)

public WorkerPool.Builder setDataDisks(int index, Disk.Builder builderForValue)

Data disks that are used by a VM in this workflow.

repeated .google.dataflow.v1beta3.Disk data_disks = 12;

Parameters
Name Description
index int
builderForValue Disk.Builder
Returns
Type Description
WorkerPool.Builder

setDefaultPackageSet(DefaultPackageSet value)

public WorkerPool.Builder setDefaultPackageSet(DefaultPackageSet value)

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.

.google.dataflow.v1beta3.DefaultPackageSet default_package_set = 4;

Parameter
Name Description
value DefaultPackageSet

The defaultPackageSet to set.
Returns
Type Description
WorkerPool.Builder

This builder for chaining.

setDefaultPackageSetValue(int value)

public WorkerPool.Builder setDefaultPackageSetValue(int value)

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.

.google.dataflow.v1beta3.DefaultPackageSet default_package_set = 4;

Parameter
Name Description
value int

The enum numeric value on the wire for defaultPackageSet to set.
Returns
Type Description
WorkerPool.Builder

This builder for chaining.

setDiskSizeGb(int value)

public WorkerPool.Builder setDiskSizeGb(int value)

Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default.

int32 disk_size_gb = 7;

Parameter
Name Description
value int

The diskSizeGb to set.
Returns
Type Description
WorkerPool.Builder

This builder for chaining.

setDiskSourceImage(String value)

public WorkerPool.Builder setDiskSourceImage(String value)

Fully qualified source image for disks.

string disk_source_image = 8;

Parameter
Name Description
value String

The diskSourceImage to set.
Returns
Type Description
WorkerPool.Builder

This builder for chaining.

setDiskSourceImageBytes(ByteString value)

public WorkerPool.Builder setDiskSourceImageBytes(ByteString value)

Fully qualified source image for disks.

string disk_source_image = 8;

Parameter
Name Description
value ByteString

The bytes for diskSourceImage to set.
Returns
Type Description
WorkerPool.Builder

This builder for chaining.

setDiskType(String value)

public WorkerPool.Builder setDiskType(String value)

Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default.

string disk_type = 16;

Parameter
Name Description
value String

The diskType to set.
Returns
Type Description
WorkerPool.Builder

This builder for chaining.

setDiskTypeBytes(ByteString value)

public WorkerPool.Builder setDiskTypeBytes(ByteString value)

Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default.

string disk_type = 16;

Parameter
Name Description
value ByteString

The bytes for diskType to set.
Returns
Type Description
WorkerPool.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public WorkerPool.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
WorkerPool.Builder
Overrides

setIpConfiguration(WorkerIPAddressConfiguration value)

public WorkerPool.Builder setIpConfiguration(WorkerIPAddressConfiguration value)

Configuration for VM IPs.

.google.dataflow.v1beta3.WorkerIPAddressConfiguration ip_configuration = 21;

Parameter
Name Description
value WorkerIPAddressConfiguration

The ipConfiguration to set.
Returns
Type Description
WorkerPool.Builder

This builder for chaining.

setIpConfigurationValue(int value)

public WorkerPool.Builder setIpConfigurationValue(int value)

Configuration for VM IPs.

.google.dataflow.v1beta3.WorkerIPAddressConfiguration ip_configuration = 21;

Parameter
Name Description
value int

The enum numeric value on the wire for ipConfiguration to set.
Returns
Type Description
WorkerPool.Builder

This builder for chaining.

setKind(String value)

public WorkerPool.Builder setKind(String value)

The kind of the worker pool; currently only harness and shuffle are supported.

string kind = 1;

Parameter
Name Description
value String

The kind to set.
Returns
Type Description
WorkerPool.Builder

This builder for chaining.

setKindBytes(ByteString value)

public WorkerPool.Builder setKindBytes(ByteString value)

The kind of the worker pool; currently only harness and shuffle are supported.

string kind = 1;

Parameter
Name Description
value ByteString

The bytes for kind to set.
Returns
Type Description
WorkerPool.Builder

This builder for chaining.

setMachineType(String value)

public WorkerPool.Builder setMachineType(String value)

Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default.

string machine_type = 5;

Parameter
Name Description
value String

The machineType to set.
Returns
Type Description
WorkerPool.Builder

This builder for chaining.

setMachineTypeBytes(ByteString value)

public WorkerPool.Builder setMachineTypeBytes(ByteString value)

Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default.

string machine_type = 5;

Parameter
Name Description
value ByteString

The bytes for machineType to set.
Returns
Type Description
WorkerPool.Builder

This builder for chaining.

setNetwork(String value)

public WorkerPool.Builder setNetwork(String value)

Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".

string network = 17;

Parameter
Name Description
value String

The network to set.
Returns
Type Description
WorkerPool.Builder

This builder for chaining.

setNetworkBytes(ByteString value)

public WorkerPool.Builder setNetworkBytes(ByteString value)

Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".

string network = 17;

Parameter
Name Description
value ByteString

The bytes for network to set.
Returns
Type Description
WorkerPool.Builder

This builder for chaining.

setNumThreadsPerWorker(int value)

public WorkerPool.Builder setNumThreadsPerWorker(int value)

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

int32 num_threads_per_worker = 20;

Parameter
Name Description
value int

The numThreadsPerWorker to set.
Returns
Type Description
WorkerPool.Builder

This builder for chaining.

setNumWorkers(int value)

public WorkerPool.Builder setNumWorkers(int value)

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.

int32 num_workers = 2;

Parameter
Name Description
value int

The numWorkers to set.
Returns
Type Description
WorkerPool.Builder

This builder for chaining.

setOnHostMaintenance(String value)

public WorkerPool.Builder setOnHostMaintenance(String value)

The action to take on host maintenance, as defined by the Google Compute Engine API.

string on_host_maintenance = 11;

Parameter
Name Description
value String

The onHostMaintenance to set.
Returns
Type Description
WorkerPool.Builder

This builder for chaining.

setOnHostMaintenanceBytes(ByteString value)

public WorkerPool.Builder setOnHostMaintenanceBytes(ByteString value)

The action to take on host maintenance, as defined by the Google Compute Engine API.

string on_host_maintenance = 11;

Parameter
Name Description
value ByteString

The bytes for onHostMaintenance to set.
Returns
Type Description
WorkerPool.Builder

This builder for chaining.

setPackages(int index, Package value)

public WorkerPool.Builder setPackages(int index, Package value)

Packages to be installed on workers.

repeated .google.dataflow.v1beta3.Package packages = 3;

Parameters
Name Description
index int
value Package
Returns
Type Description
WorkerPool.Builder

setPackages(int index, Package.Builder builderForValue)

public WorkerPool.Builder setPackages(int index, Package.Builder builderForValue)

Packages to be installed on workers.

repeated .google.dataflow.v1beta3.Package packages = 3;

Parameters
Name Description
index int
builderForValue Package.Builder
Returns
Type Description
WorkerPool.Builder

setPoolArgs(Any value)

public WorkerPool.Builder setPoolArgs(Any value)

Extra arguments for this worker pool.

.google.protobuf.Any pool_args = 15;

Parameter
Name Description
value Any
Returns
Type Description
WorkerPool.Builder

setPoolArgs(Any.Builder builderForValue)

public WorkerPool.Builder setPoolArgs(Any.Builder builderForValue)

Extra arguments for this worker pool.

.google.protobuf.Any pool_args = 15;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
WorkerPool.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public WorkerPool.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
WorkerPool.Builder
Overrides

setSdkHarnessContainerImages(int index, SdkHarnessContainerImage value)

public WorkerPool.Builder setSdkHarnessContainerImages(int index, SdkHarnessContainerImage value)

Set of SDK harness containers needed to execute this pipeline. This will only be set in the Fn API path. For non-cross-language pipelines this should have only one entry. Cross-language pipelines will have two or more entries.

repeated .google.dataflow.v1beta3.SdkHarnessContainerImage sdk_harness_container_images = 22;

Parameters
Name Description
index int
value SdkHarnessContainerImage
Returns
Type Description
WorkerPool.Builder

setSdkHarnessContainerImages(int index, SdkHarnessContainerImage.Builder builderForValue)

public WorkerPool.Builder setSdkHarnessContainerImages(int index, SdkHarnessContainerImage.Builder builderForValue)

Set of SDK harness containers needed to execute this pipeline. This will only be set in the Fn API path. For non-cross-language pipelines this should have only one entry. Cross-language pipelines will have two or more entries.

repeated .google.dataflow.v1beta3.SdkHarnessContainerImage sdk_harness_container_images = 22;

Parameters
Name Description
index int
builderForValue SdkHarnessContainerImage.Builder
Returns
Type Description
WorkerPool.Builder

setSubnetwork(String value)

public WorkerPool.Builder setSubnetwork(String value)

Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK".

string subnetwork = 19;

Parameter
Name Description
value String

The subnetwork to set.
Returns
Type Description
WorkerPool.Builder

This builder for chaining.

setSubnetworkBytes(ByteString value)

public WorkerPool.Builder setSubnetworkBytes(ByteString value)

Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK".

string subnetwork = 19;

Parameter
Name Description
value ByteString

The bytes for subnetwork to set.
Returns
Type Description
WorkerPool.Builder

This builder for chaining.

setTaskrunnerSettings(TaskRunnerSettings value)

public WorkerPool.Builder setTaskrunnerSettings(TaskRunnerSettings value)

Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.

.google.dataflow.v1beta3.TaskRunnerSettings taskrunner_settings = 10;

Parameter
Name Description
value TaskRunnerSettings
Returns
Type Description
WorkerPool.Builder

setTaskrunnerSettings(TaskRunnerSettings.Builder builderForValue)

public WorkerPool.Builder setTaskrunnerSettings(TaskRunnerSettings.Builder builderForValue)

Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.

.google.dataflow.v1beta3.TaskRunnerSettings taskrunner_settings = 10;

Parameter
Name Description
builderForValue TaskRunnerSettings.Builder
Returns
Type Description
WorkerPool.Builder

setTeardownPolicy(TeardownPolicy value)

public WorkerPool.Builder setTeardownPolicy(TeardownPolicy value)

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.

.google.dataflow.v1beta3.TeardownPolicy teardown_policy = 6;

Parameter
Name Description
value TeardownPolicy

The teardownPolicy to set.
Returns
Type Description
WorkerPool.Builder

This builder for chaining.

setTeardownPolicyValue(int value)

public WorkerPool.Builder setTeardownPolicyValue(int value)

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.

.google.dataflow.v1beta3.TeardownPolicy teardown_policy = 6;

Parameter
Name Description
value int

The enum numeric value on the wire for teardownPolicy to set.
Returns
Type Description
WorkerPool.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final WorkerPool.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
WorkerPool.Builder
Overrides

setWorkerHarnessContainerImage(String value)

public WorkerPool.Builder setWorkerHarnessContainerImage(String value)

Required. Docker container image that executes the Cloud Dataflow worker harness, residing in Google Container Registry.

Deprecated for the Fn API path. Use sdk_harness_container_images instead.

string worker_harness_container_image = 18;

Parameter
Name Description
value String

The workerHarnessContainerImage to set.
Returns
Type Description
WorkerPool.Builder

This builder for chaining.

setWorkerHarnessContainerImageBytes(ByteString value)

public WorkerPool.Builder setWorkerHarnessContainerImageBytes(ByteString value)

Required. Docker container image that executes the Cloud Dataflow worker harness, residing in Google Container Registry.

Deprecated for the Fn API path. Use sdk_harness_container_images instead.

string worker_harness_container_image = 18;

Parameter
Name Description
value ByteString

The bytes for workerHarnessContainerImage to set.
Returns
Type Description
WorkerPool.Builder

This builder for chaining.

setZone(String value)

public WorkerPool.Builder setZone(String value)

Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default.

string zone = 9;

Parameter
Name Description
value String

The zone to set.
Returns
Type Description
WorkerPool.Builder

This builder for chaining.

setZoneBytes(ByteString value)

public WorkerPool.Builder setZoneBytes(ByteString value)

Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default.

string zone = 9;

Parameter
Name Description
value ByteString

The bytes for zone to set.
Returns
Type Description
WorkerPool.Builder

This builder for chaining.