Class protos.google.dataflow.v1beta3.WorkerPool

Version 1.0.2

• 3.0.2 (latest)
• 2.1.2
• 2.0.1
• 1.2.0
• 1.1.0
• 1.0.2

Represents a WorkerPool.

Package

@google-cloud/dataflow!

Constructors

(constructor)(properties)

constructor(properties?: google.dataflow.v1beta3.IWorkerPool);

Constructs a new WorkerPool.

Parameter

Type	Name	Description
IWorkerPool	properties	Properties to set

Properties

autoscalingSettings

public autoscalingSettings?: (google.dataflow.v1beta3.IAutoscalingSettings|null);

WorkerPool autoscalingSettings.

Property Value

Type	Description
(google.dataflow.v1beta3.IAutoscalingSettings|null)

dataDisks

public dataDisks: google.dataflow.v1beta3.IDisk[];

WorkerPool dataDisks.

Property Value

Type	Description
google.dataflow.v1beta3.IDisk[]

defaultPackageSet

public defaultPackageSet: (google.dataflow.v1beta3.DefaultPackageSet|keyof typeof google.dataflow.v1beta3.DefaultPackageSet);

WorkerPool defaultPackageSet.

Property Value

Type	Description
(google.dataflow.v1beta3.DefaultPackageSet|keyof typeof google.dataflow.v1beta3.DefaultPackageSet)

diskSizeGb

public diskSizeGb: number;

WorkerPool diskSizeGb.

Property Value

Type	Description
number

diskSourceImage

public diskSourceImage: string;

WorkerPool diskSourceImage.

Property Value

Type	Description
string

diskType

public diskType: string;

WorkerPool diskType.

Property Value

Type	Description
string

ipConfiguration

public ipConfiguration: (google.dataflow.v1beta3.WorkerIPAddressConfiguration|keyof typeof google.dataflow.v1beta3.WorkerIPAddressConfiguration);

WorkerPool ipConfiguration.

Property Value

Type	Description
(google.dataflow.v1beta3.WorkerIPAddressConfiguration|keyof typeof google.dataflow.v1beta3.WorkerIPAddressConfiguration)

kind

public kind: string;

WorkerPool kind.

Property Value

Type	Description
string

machineType

public machineType: string;

WorkerPool machineType.

Property Value

Type	Description
string

metadata

public metadata: { [k: string]: string };

WorkerPool metadata.

Property Value

Type	Description
{ [k: string]: string }

network

public network: string;

WorkerPool network.

Property Value

Type	Description
string

numThreadsPerWorker

public numThreadsPerWorker: number;

WorkerPool numThreadsPerWorker.

Property Value

Type	Description
number

numWorkers

public numWorkers: number;

WorkerPool numWorkers.

Property Value

Type	Description
number

onHostMaintenance

public onHostMaintenance: string;

WorkerPool onHostMaintenance.

Property Value

Type	Description
string

packages

public packages: google.dataflow.v1beta3.IPackage[];

WorkerPool packages.

Property Value

Type	Description
google.dataflow.v1beta3.IPackage[]

poolArgs

public poolArgs?: (google.protobuf.IAny|null);

WorkerPool poolArgs.

Property Value

Type	Description
(google.protobuf.IAny|null)

sdkHarnessContainerImages

public sdkHarnessContainerImages: google.dataflow.v1beta3.ISdkHarnessContainerImage[];

WorkerPool sdkHarnessContainerImages.

Property Value

Type	Description
google.dataflow.v1beta3.ISdkHarnessContainerImage[]

subnetwork

public subnetwork: string;

WorkerPool subnetwork.

Property Value

Type	Description
string

taskrunnerSettings

public taskrunnerSettings?: (google.dataflow.v1beta3.ITaskRunnerSettings|null);

WorkerPool taskrunnerSettings.

Property Value

Type	Description
(google.dataflow.v1beta3.ITaskRunnerSettings|null)

teardownPolicy

public teardownPolicy: (google.dataflow.v1beta3.TeardownPolicy|keyof typeof google.dataflow.v1beta3.TeardownPolicy);

WorkerPool teardownPolicy.

Property Value

Type	Description
(google.dataflow.v1beta3.TeardownPolicy|keyof typeof google.dataflow.v1beta3.TeardownPolicy)

workerHarnessContainerImage

public workerHarnessContainerImage: string;

WorkerPool workerHarnessContainerImage.

Property Value

Type	Description
string

zone

public zone: string;

WorkerPool zone.

Property Value

Type	Description
string

Methods

create(properties)

public static create(properties?: google.dataflow.v1beta3.IWorkerPool): google.dataflow.v1beta3.WorkerPool;

Creates a new WorkerPool instance using the specified properties.

Parameter

Type	Name	Description
IWorkerPool	properties	Properties to set

Returns

Type	Description
google.dataflow.v1beta3.WorkerPool	WorkerPool instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.dataflow.v1beta3.WorkerPool;

Decodes a WorkerPool message from the specified reader or buffer.

Parameters

Type	Name	Description
($protobuf.Reader|Uint8Array)	reader	Reader or buffer to decode from
number	length	Message length if known beforehand

Returns

Type	Description
google.dataflow.v1beta3.WorkerPool	WorkerPool

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.dataflow.v1beta3.WorkerPool;

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

Parameter

Type	Name	Description
($protobuf.Reader|Uint8Array)	reader	Reader or buffer to decode from

Returns

Type	Description
google.dataflow.v1beta3.WorkerPool	WorkerPool

encode(message, writer)

public static encode(message: google.dataflow.v1beta3.IWorkerPool, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified WorkerPool message. Does not implicitly messages.

Parameters

Type	Name	Description
IWorkerPool	message	WorkerPool message or plain object to encode
$protobuf.Writer	writer	Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.dataflow.v1beta3.IWorkerPool, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Type	Name	Description
IWorkerPool	message	WorkerPool message or plain object to encode
$protobuf.Writer	writer	Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.dataflow.v1beta3.WorkerPool;

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

Parameter

Type	Name	Description
{ [k: string]: any }	object	Plain object

Returns

Type	Description
google.dataflow.v1beta3.WorkerPool	WorkerPool

toJSON()

public toJSON(): { [k: string]: any };

Converts this WorkerPool to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

public static toObject(message: google.dataflow.v1beta3.WorkerPool, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters

Type	Name	Description
google.dataflow.v1beta3.WorkerPool	message	WorkerPool
$protobuf.IConversionOptions	options	Conversion options

Returns

Type	Description
{ [k: string]: any }	Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a WorkerPool message.

Parameter

Type	Name	Description
{ [k: string]: any }	message	Plain object to verify

Returns

Type	Description
(string|null)	null if valid, otherwise the reason why it is not