Class WorkerPool

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.

Attributes
NameDescription
strkind
The kind of the worker pool; currently only ``harness`` and ``shuffle`` are supported.
intnum_workers
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.
Sequence[google.cloud.dataflow_v1beta3.types.Package]packages
Packages to be installed on workers.
google.cloud.dataflow_v1beta3.types.DefaultPackageSetdefault_package_set
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.
strmachine_type
Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default.
google.cloud.dataflow_v1beta3.types.TeardownPolicyteardown_policy
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.
intdisk_size_gb
Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default.
strdisk_type
Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default.
strdisk_source_image
Fully qualified source image for disks.
strzone
Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default.
google.cloud.dataflow_v1beta3.types.TaskRunnerSettingstaskrunner_settings
Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.
stron_host_maintenance
The action to take on host maintenance, as defined by the Google Compute Engine API.
Sequence[google.cloud.dataflow_v1beta3.types.Disk]data_disks
Data disks that are used by a VM in this workflow.
Sequence[google.cloud.dataflow_v1beta3.types.WorkerPool.MetadataEntry]metadata
Metadata to set on the Google Compute Engine VMs.
google.cloud.dataflow_v1beta3.types.AutoscalingSettingsautoscaling_settings
Settings for autoscaling of this WorkerPool.
google.protobuf.any_pb2.Anypool_args
Extra arguments for this worker pool.
strnetwork
Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
strsubnetwork
Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK".
strworker_harness_container_image
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.
intnum_threads_per_worker
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).
google.cloud.dataflow_v1beta3.types.WorkerIPAddressConfigurationip_configuration
Configuration for VM IPs.
Sequence[google.cloud.dataflow_v1beta3.types.SdkHarnessContainerImage]sdk_harness_container_images
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.

Inheritance

builtins.object > proto.message.Message > WorkerPool

Classes

MetadataEntry

MetadataEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

API documentation for dataflow_v1beta3.types.WorkerPool.MetadataEntry class.