Interface WorkerPoolOrBuilder (0.59.0) 

public interface WorkerPoolOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsMetadata(String key)

public abstract 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 abstract AutoscalingSettings getAutoscalingSettings()

Settings for autoscaling of this WorkerPool.

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

Returns
Type Description
AutoscalingSettings

The autoscalingSettings.

getAutoscalingSettingsOrBuilder()

public abstract AutoscalingSettingsOrBuilder getAutoscalingSettingsOrBuilder()

Settings for autoscaling of this WorkerPool.

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

Returns
Type Description
AutoscalingSettingsOrBuilder

getDataDisks(int index)

public abstract 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

getDataDisksCount()

public abstract 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 abstract 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 abstract 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 abstract 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>

getDefaultPackageSet()

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

getDiskSizeGb()

public abstract 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 abstract String getDiskSourceImage()

Fully qualified source image for disks.

string disk_source_image = 8;

Returns
Type Description
String

The diskSourceImage.

getDiskSourceImageBytes()

public abstract ByteString getDiskSourceImageBytes()

Fully qualified source image for disks.

string disk_source_image = 8;

Returns
Type Description
ByteString

The bytes for diskSourceImage.

getDiskType()

public abstract 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 abstract 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 abstract WorkerIPAddressConfiguration getIpConfiguration()

Configuration for VM IPs.

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

Returns
Type Description
WorkerIPAddressConfiguration

The ipConfiguration.

getIpConfigurationValue()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract Map<String,String> getMetadata()

Use #getMetadataMap() instead.

Returns
Type Description
Map<String,String>

getMetadataCount()

public abstract int getMetadataCount()

Metadata to set on the Google Compute Engine VMs.

map<string, string> metadata = 13;

Returns
Type Description
int

getMetadataMap()

public abstract 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 abstract 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 abstract 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

getNetwork()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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

getPackagesCount()

public abstract int getPackagesCount()

Packages to be installed on workers.

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

Returns
Type Description
int

getPackagesList()

public abstract 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 abstract 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 abstract 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 abstract Any getPoolArgs()

Extra arguments for this worker pool.

.google.protobuf.Any pool_args = 15;

Returns
Type Description
Any

The poolArgs.

getPoolArgsOrBuilder()

public abstract AnyOrBuilder getPoolArgsOrBuilder()

Extra arguments for this worker pool.

.google.protobuf.Any pool_args = 15;

Returns
Type Description
AnyOrBuilder

getSdkHarnessContainerImages(int index)

public abstract 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

getSdkHarnessContainerImagesCount()

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

getTaskrunnerSettingsOrBuilder()

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