Represents a WorkerPool.
Package
@google-cloud/dataflowConstructors
(constructor)(properties)
constructor(properties?: google.dataflow.v1beta3.IWorkerPool);Constructs a new WorkerPool.
| Parameter | |
|---|---|
| Name | Description |
properties |
IWorkerPool
Properties to set |
Properties
autoscalingSettings
public autoscalingSettings?: (google.dataflow.v1beta3.IAutoscalingSettings|null);WorkerPool autoscalingSettings.
dataDisks
public dataDisks: google.dataflow.v1beta3.IDisk[];WorkerPool dataDisks.
defaultPackageSet
public defaultPackageSet: (google.dataflow.v1beta3.DefaultPackageSet|keyof typeof google.dataflow.v1beta3.DefaultPackageSet);WorkerPool defaultPackageSet.
diskSizeGb
public diskSizeGb: number;WorkerPool diskSizeGb.
diskSourceImage
public diskSourceImage: string;WorkerPool diskSourceImage.
diskType
public diskType: string;WorkerPool diskType.
ipConfiguration
public ipConfiguration: (google.dataflow.v1beta3.WorkerIPAddressConfiguration|keyof typeof google.dataflow.v1beta3.WorkerIPAddressConfiguration);WorkerPool ipConfiguration.
kind
public kind: string;WorkerPool kind.
machineType
public machineType: string;WorkerPool machineType.
metadata
public metadata: { [k: string]: string };WorkerPool metadata.
network
public network: string;WorkerPool network.
numThreadsPerWorker
public numThreadsPerWorker: number;WorkerPool numThreadsPerWorker.
numWorkers
public numWorkers: number;WorkerPool numWorkers.
onHostMaintenance
public onHostMaintenance: string;WorkerPool onHostMaintenance.
packages
public packages: google.dataflow.v1beta3.IPackage[];WorkerPool packages.
poolArgs
public poolArgs?: (google.protobuf.IAny|null);WorkerPool poolArgs.
sdkHarnessContainerImages
public sdkHarnessContainerImages: google.dataflow.v1beta3.ISdkHarnessContainerImage[];WorkerPool sdkHarnessContainerImages.
subnetwork
public subnetwork: string;WorkerPool subnetwork.
taskrunnerSettings
public taskrunnerSettings?: (google.dataflow.v1beta3.ITaskRunnerSettings|null);WorkerPool taskrunnerSettings.
teardownPolicy
public teardownPolicy: (google.dataflow.v1beta3.TeardownPolicy|keyof typeof google.dataflow.v1beta3.TeardownPolicy);WorkerPool teardownPolicy.
workerHarnessContainerImage
public workerHarnessContainerImage: string;WorkerPool workerHarnessContainerImage.
zone
public zone: string;WorkerPool zone.
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 | |
|---|---|
| Name | Description |
properties |
IWorkerPool
Properties to set |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
message |
IWorkerPool
WorkerPool message or plain object to encode |
writer |
$protobuf.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 | |
|---|---|
| Name | Description |
message |
IWorkerPool
WorkerPool message or plain object to encode |
writer |
$protobuf.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 | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
WorkerPool | WorkerPool |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for WorkerPool
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
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 | |
|---|---|
| Name | Description |
message |
WorkerPool
WorkerPool |
options |
$protobuf.IConversionOptions
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 | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|