WorkerPool

google.dataflow.v1beta3. WorkerPool

Represents a WorkerPool.

Constructor

new WorkerPool(propertiesopt)

Constructs a new WorkerPool.

Parameters:
Name Type Attributes Description
properties google.dataflow.v1beta3.IWorkerPool <optional>

Properties to set

Implements:
  • IWorkerPool

Members

autoscalingSettings

WorkerPool autoscalingSettings.

dataDisks

WorkerPool dataDisks.

defaultPackageSet

WorkerPool defaultPackageSet.

diskSizeGb

WorkerPool diskSizeGb.

diskSourceImage

WorkerPool diskSourceImage.

diskType

WorkerPool diskType.

ipConfiguration

WorkerPool ipConfiguration.

kind

WorkerPool kind.

machineType

WorkerPool machineType.

metadata

WorkerPool metadata.

network

WorkerPool network.

numThreadsPerWorker

WorkerPool numThreadsPerWorker.

numWorkers

WorkerPool numWorkers.

onHostMaintenance

WorkerPool onHostMaintenance.

packages

WorkerPool packages.

poolArgs

WorkerPool poolArgs.

sdkHarnessContainerImages

WorkerPool sdkHarnessContainerImages.

subnetwork

WorkerPool subnetwork.

taskrunnerSettings

WorkerPool taskrunnerSettings.

teardownPolicy

WorkerPool teardownPolicy.

workerHarnessContainerImage

WorkerPool workerHarnessContainerImage.

zone

WorkerPool zone.

Methods

toJSON() → {Object.<string, *>}

Converts this WorkerPool to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.dataflow.v1beta3.WorkerPool}

Creates a new WorkerPool instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.dataflow.v1beta3.IWorkerPool <optional>

Properties to set

Returns:
Type Description
google.dataflow.v1beta3.WorkerPool

WorkerPool instance

(static) decode(reader, lengthopt) → {google.dataflow.v1beta3.WorkerPool}

Decodes a WorkerPool message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.dataflow.v1beta3.WorkerPool

WorkerPool

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.dataflow.v1beta3.WorkerPool}

Decodes a WorkerPool message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.dataflow.v1beta3.WorkerPool

WorkerPool

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified WorkerPool message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.dataflow.v1beta3.IWorkerPool

WorkerPool message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified WorkerPool message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.dataflow.v1beta3.IWorkerPool

WorkerPool message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.dataflow.v1beta3.WorkerPool}

Creates a WorkerPool message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.dataflow.v1beta3.WorkerPool

WorkerPool

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for WorkerPool

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a WorkerPool message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.dataflow.v1beta3.WorkerPool

WorkerPool

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a WorkerPool message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not