Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

WorkerPool

import type { WorkerPool } from "https://googleapis.deno.dev/v1/dataflow:v1b3.ts";

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.

interface WorkerPool {

autoscalingSettings?: AutoscalingSettings;

dataDisks?: Disk[];

defaultPackageSet?:

| "DEFAULT_PACKAGE_SET_UNKNOWN"

| "DEFAULT_PACKAGE_SET_NONE"

| "DEFAULT_PACKAGE_SET_JAVA"

| "DEFAULT_PACKAGE_SET_PYTHON";

diskSizeGb?: number;

diskSourceImage?: string;

diskType?: string;

ipConfiguration?: "WORKER_IP_UNSPECIFIED" | "WORKER_IP_PUBLIC" | "WORKER_IP_PRIVATE";

kind?: string;

machineType?: string;

metadata?: {

[key: string]: string;

};

network?: string;

numThreadsPerWorker?: number;

numWorkers?: number;

onHostMaintenance?: string;

packages?: Package[];

poolArgs?: {

[key: string]: any;

};

sdkHarnessContainerImages?: SdkHarnessContainerImage[];

subnetwork?: string;

taskrunnerSettings?: TaskRunnerSettings;

teardownPolicy?:

| "TEARDOWN_POLICY_UNKNOWN"

| "TEARDOWN_ALWAYS"

| "TEARDOWN_ON_SUCCESS"

| "TEARDOWN_NEVER";

workerHarnessContainerImage?: string;

zone?: string;

}

§Properties

autoscalingSettings?: AutoscalingSettings

Settings for autoscaling of this WorkerPool.

dataDisks?: Disk[]

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

defaultPackageSet?: "DEFAULT_PACKAGE_SET_UNKNOWN" | "DEFAULT_PACKAGE_SET_NONE" | "DEFAULT_PACKAGE_SET_JAVA" | "DEFAULT_PACKAGE_SET_PYTHON"

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?: number

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

diskSourceImage?: string

Fully qualified source image for disks.

diskType?: string

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

ipConfiguration?: "WORKER_IP_UNSPECIFIED" | "WORKER_IP_PUBLIC" | "WORKER_IP_PRIVATE"

Configuration for VM IPs.

kind?: string

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

machineType?: string

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

metadata?: {

[key: string]: string;

}

Metadata to set on the Google Compute Engine VMs.

network?: string

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

numThreadsPerWorker?: number

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

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?: string

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

packages?: Package[]

Packages to be installed on workers.

poolArgs?: {

[key: string]: any;

}

Extra arguments for this worker pool.

sdkHarnessContainerImages?: SdkHarnessContainerImage[]

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?: string

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

taskrunnerSettings?: TaskRunnerSettings

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

teardownPolicy?: "TEARDOWN_POLICY_UNKNOWN" | "TEARDOWN_ALWAYS" | "TEARDOWN_ON_SUCCESS" | "TEARDOWN_NEVER"

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?: string

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.

zone?: string

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