Class protos.google.cloud.aiplatform.v1.WorkerPoolSpec (1.17.0)

Represents a WorkerPoolSpec.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.aiplatform.v1.IWorkerPoolSpec);

Constructs a new WorkerPoolSpec.

Parameter

Name	Description
properties	`IWorkerPoolSpec` Properties to set

Properties

containerSpec

public containerSpec?: (google.cloud.aiplatform.v1.IContainerSpec|null);

WorkerPoolSpec containerSpec.

diskSpec

public diskSpec?: (google.cloud.aiplatform.v1.IDiskSpec|null);

WorkerPoolSpec diskSpec.

machineSpec

public machineSpec?: (google.cloud.aiplatform.v1.IMachineSpec|null);

WorkerPoolSpec machineSpec.

pythonPackageSpec

public pythonPackageSpec?: (google.cloud.aiplatform.v1.IPythonPackageSpec|null);

WorkerPoolSpec pythonPackageSpec.

replicaCount

public replicaCount: (number|Long|string);

WorkerPoolSpec replicaCount.

task

public task?: ("containerSpec"|"pythonPackageSpec");

WorkerPoolSpec task.

Methods

create(properties)

public static create(properties?: google.cloud.aiplatform.v1.IWorkerPoolSpec): google.cloud.aiplatform.v1.WorkerPoolSpec;

Creates a new WorkerPoolSpec instance using the specified properties.

Parameter

Name	Description
properties	`IWorkerPoolSpec` Properties to set

Returns

Type	Description
google.cloud.aiplatform.v1.WorkerPoolSpec	WorkerPoolSpec instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.WorkerPoolSpec;

Decodes a WorkerPoolSpec message from the specified reader or buffer.

Parameters

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

Returns

Type	Description
google.cloud.aiplatform.v1.WorkerPoolSpec	WorkerPoolSpec

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.WorkerPoolSpec;

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

Parameter

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

Returns

Type	Description
google.cloud.aiplatform.v1.WorkerPoolSpec	WorkerPoolSpec

encode(message, writer)

public static encode(message: google.cloud.aiplatform.v1.IWorkerPoolSpec, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified WorkerPoolSpec message. Does not implicitly messages.

Parameters

Name	Description
message	`IWorkerPoolSpec` WorkerPoolSpec 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.cloud.aiplatform.v1.IWorkerPoolSpec, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IWorkerPoolSpec` WorkerPoolSpec 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.cloud.aiplatform.v1.WorkerPoolSpec;

Creates a WorkerPoolSpec 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
google.cloud.aiplatform.v1.WorkerPoolSpec	WorkerPoolSpec

toJSON()

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

Converts this WorkerPoolSpec to JSON.

Returns

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

toObject(message, options)

public static toObject(message: google.cloud.aiplatform.v1.WorkerPoolSpec, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters

Name	Description
message	`google.cloud.aiplatform.v1.WorkerPoolSpec` WorkerPoolSpec
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 WorkerPoolSpec message.

Parameter

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

Returns

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