public final class WorkerPool extends GeneratedMessageV3 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
Static Fields
AUTOSCALING_SETTINGS_FIELD_NUMBER
public static final int AUTOSCALING_SETTINGS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DATA_DISKS_FIELD_NUMBER
public static final int DATA_DISKS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DEFAULT_PACKAGE_SET_FIELD_NUMBER
public static final int DEFAULT_PACKAGE_SET_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DISK_SIZE_GB_FIELD_NUMBER
public static final int DISK_SIZE_GB_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DISK_SOURCE_IMAGE_FIELD_NUMBER
public static final int DISK_SOURCE_IMAGE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DISK_TYPE_FIELD_NUMBER
public static final int DISK_TYPE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
IP_CONFIGURATION_FIELD_NUMBER
public static final int IP_CONFIGURATION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
KIND_FIELD_NUMBER
public static final int KIND_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MACHINE_TYPE_FIELD_NUMBER
public static final int MACHINE_TYPE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int METADATA_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NETWORK_FIELD_NUMBER
public static final int NETWORK_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NUM_THREADS_PER_WORKER_FIELD_NUMBER
public static final int NUM_THREADS_PER_WORKER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NUM_WORKERS_FIELD_NUMBER
public static final int NUM_WORKERS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ON_HOST_MAINTENANCE_FIELD_NUMBER
public static final int ON_HOST_MAINTENANCE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PACKAGES_FIELD_NUMBER
public static final int PACKAGES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
POOL_ARGS_FIELD_NUMBER
public static final int POOL_ARGS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SDK_HARNESS_CONTAINER_IMAGES_FIELD_NUMBER
public static final int SDK_HARNESS_CONTAINER_IMAGES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SUBNETWORK_FIELD_NUMBER
public static final int SUBNETWORK_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
TASKRUNNER_SETTINGS_FIELD_NUMBER
public static final int TASKRUNNER_SETTINGS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
TEARDOWN_POLICY_FIELD_NUMBER
public static final int TEARDOWN_POLICY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
WORKER_HARNESS_CONTAINER_IMAGE_FIELD_NUMBER
public static final int WORKER_HARNESS_CONTAINER_IMAGE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ZONE_FIELD_NUMBER
public static final int ZONE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static WorkerPool getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static WorkerPool.Builder newBuilder()
newBuilder(WorkerPool prototype)
public static WorkerPool.Builder newBuilder(WorkerPool prototype)
public static WorkerPool parseDelimitedFrom(InputStream input)
public static WorkerPool parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static WorkerPool parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static WorkerPool parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static WorkerPool parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static WorkerPool parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static WorkerPool parseFrom(CodedInputStream input)
public static WorkerPool parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static WorkerPool parseFrom(InputStream input)
public static WorkerPool parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static WorkerPool parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static WorkerPool parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<WorkerPool> parser()
Methods
public boolean containsMetadata(String key)
Metadata to set on the Google Compute Engine VMs.
map<string, string> metadata = 13;
| Parameter |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getAutoscalingSettings()
public AutoscalingSettings getAutoscalingSettings()
Settings for autoscaling of this WorkerPool.
.google.dataflow.v1beta3.AutoscalingSettings autoscaling_settings = 14;
getAutoscalingSettingsOrBuilder()
public AutoscalingSettingsOrBuilder getAutoscalingSettingsOrBuilder()
Settings for autoscaling of this WorkerPool.
.google.dataflow.v1beta3.AutoscalingSettings autoscaling_settings = 14;
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 | |
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;
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
|
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()
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;
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.
|
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;
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()
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.
|
public Map<String,String> getMetadata()
public int getMetadataCount()
Metadata to set on the Google Compute Engine VMs.
map<string, string> metadata = 13;
| Returns |
|---|
| Type | Description |
int | |
public Map<String,String> getMetadataMap()
Metadata to set on the Google Compute Engine VMs.
map<string, string> metadata = 13;
public String getMetadataOrDefault(String key, String defaultValue)
Metadata to set on the Google Compute Engine VMs.
map<string, string> metadata = 13;
public String getMetadataOrThrow(String key)
Metadata to set on the Google Compute Engine VMs.
map<string, string> metadata = 13;
| Parameter |
|---|
| Name | Description |
key | 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
|
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;
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
|
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> | |
getParserForType()
public Parser<WorkerPool> getParserForType()
Overrides
getPoolArgs()
Extra arguments for this worker pool.
.google.protobuf.Any pool_args = 15;
| Returns |
|---|
| Type | Description |
Any | The poolArgs.
|
getPoolArgsOrBuilder()
public AnyOrBuilder getPoolArgsOrBuilder()
Extra arguments for this worker pool.
.google.protobuf.Any pool_args = 15;
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
|
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;
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
|
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> | |
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
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;
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;
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;
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.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
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()
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.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public WorkerPool.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected WorkerPool.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public WorkerPool.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
