WorkerPoolResponse class

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.

Constructors

WorkerPoolResponse({required Input<AutoscalingSettingsResponse> autoscalingSettings, required Input<List<DiskResponse>> dataDisks, required Input<String> defaultPackageSet, required Input<int> diskSizeGb, required Input<String> diskSourceImage, required Input<String> diskType, required Input<String> ipConfiguration, required Input<String> kind, required Input<String> machineType, required Input<Map<String, String>> metadata, required Input<String> network, required Input<int> numThreadsPerWorker, required Input<int> numWorkers, required Input<String> onHostMaintenance, required Input<List<PackageResponse>> packages, required Input<Map<String, String>> poolArgs, required Input<List<SdkHarnessContainerImageResponse>> sdkHarnessContainerImages, required Input<String> subnetwork, required Input<TaskRunnerSettingsResponse> taskrunnerSettings, required Input<String> teardownPolicy, required Input<String> workerHarnessContainerImage, required Input<String> zone})
Creates a new WorkerPoolResponse. autoscalingSettings Settings for autoscaling of this WorkerPool. dataDisks Data disks that are used by a VM in this workflow. defaultPackageSet The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language. diskSizeGb Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default. diskSourceImage Fully qualified source image for disks. diskType Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. ipConfiguration Configuration for VM IPs. kind The kind of the worker pool; currently only harness and shuffle are supported. machineType Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default. metadata Metadata to set on the Google Compute Engine VMs. network Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". numThreadsPerWorker The number of threads per worker harness. If empty or unspecified, the service will choose a number of threads (according to the number of cores on the selected machine type for batch, or 1 by convention for streaming). numWorkers Number of Google Compute Engine workers in this pool needed to execute the job. If zero or unspecified, the service will attempt to choose a reasonable default. onHostMaintenance The action to take on host maintenance, as defined by the Google Compute Engine API. packages Packages to be installed on workers. poolArgs Extra arguments for this worker pool. sdkHarnessContainerImages 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. subnetwork Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK". taskrunnerSettings Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field. teardownPolicy Sets the policy for determining when to turndown worker pool. Allowed values are: TEARDOWN_ALWAYS, TEARDOWN_ON_SUCCESS, and TEARDOWN_NEVER. TEARDOWN_ALWAYS means workers are always torn down regardless of whether the job succeeds. TEARDOWN_ON_SUCCESS means workers are torn down if the job succeeds. TEARDOWN_NEVER means the workers are never torn down. If the workers are not torn down by the service, they will continue to run and use Google Compute Engine VM resources in the user's project until they are explicitly terminated by the user. Because of this, Google recommends using the TEARDOWN_ALWAYS policy except for small, manually supervised test jobs. If unknown or unspecified, the service will attempt to choose a reasonable default. workerHarnessContainerImage 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. zone Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default.
const
WorkerPoolResponse.fromMap(Map<String, dynamic> map)
factory

Properties

autoscalingSettings → Input<AutoscalingSettingsResponse>
Settings for autoscaling of this WorkerPool.
final
dataDisks → Input<List<DiskResponse>>
Data disks that are used by a VM in this workflow.
final
defaultPackageSet → Input<String>
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.
final
diskSizeGb → Input<int>
Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default.
final
diskSourceImage → Input<String>
Fully qualified source image for disks.
final
diskType → Input<String>
Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default.
final
hashCode → int
The hash code for this object.
no setterinherited
ipConfiguration → Input<String>
Configuration for VM IPs.
final
kind → Input<String>
The kind of the worker pool; currently only harness and shuffle are supported.
final
machineType → Input<String>
Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default.
final
metadata → Input<Map<String, String>>
Metadata to set on the Google Compute Engine VMs.
final
network → Input<String>
Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
final
numThreadsPerWorker → Input<int>
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).
final
numWorkers → Input<int>
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.
final
onHostMaintenance → Input<String>
The action to take on host maintenance, as defined by the Google Compute Engine API.
final
packages → Input<List<PackageResponse>>
Packages to be installed on workers.
final
poolArgs → Input<Map<String, String>>
Extra arguments for this worker pool.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sdkHarnessContainerImages → Input<List<SdkHarnessContainerImageResponse>>
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.
final
subnetwork → Input<String>
Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK".
final
taskrunnerSettings → Input<TaskRunnerSettingsResponse>
Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.
final
teardownPolicy → Input<String>
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.
final
workerHarnessContainerImage → Input<String>
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.
final
zone → Input<String>
Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited