Class protos.google.devtools.cloudbuild.v1.WorkerPool (2.2.7)

Represents a WorkerPool.

Package

@google-cloud/cloudbuild!

Constructors

(constructor)(properties)

constructor(properties?: google.devtools.cloudbuild.v1.IWorkerPool);

Constructs a new WorkerPool.

Parameter

Name	Description
properties	`IWorkerPool` Properties to set

Properties

createTime

public createTime?: (google.protobuf.ITimestamp|null);

WorkerPool createTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

deleteTime

public deleteTime?: (google.protobuf.ITimestamp|null);

WorkerPool deleteTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

name

public name: string;

WorkerPool name.

Property Value

Type	Description
string

projectId

public projectId: string;

WorkerPool projectId.

Property Value

Type	Description
string

regions

public regions: google.devtools.cloudbuild.v1.WorkerPool.Region[];

WorkerPool regions.

Property Value

Type	Description
google.devtools.cloudbuild.v1.WorkerPool.Region[]

serviceAccountEmail

public serviceAccountEmail: string;

WorkerPool serviceAccountEmail.

Property Value

Type	Description
string

status

public status: (google.devtools.cloudbuild.v1.WorkerPool.Status|keyof typeof google.devtools.cloudbuild.v1.WorkerPool.Status);

WorkerPool status.

Property Value

Type	Description
(google.devtools.cloudbuild.v1.WorkerPool.Status\|keyof typeof google.devtools.cloudbuild.v1.WorkerPool.Status)

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

WorkerPool updateTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

workerConfig

public workerConfig?: (google.devtools.cloudbuild.v1.IWorkerConfig|null);

WorkerPool workerConfig.

Property Value

Type	Description
(google.devtools.cloudbuild.v1.IWorkerConfig\|null)

workerCount

public workerCount: (number|Long|string);

WorkerPool workerCount.

Property Value

Type	Description
(number\|Long\|string)

Methods

create(properties)

public static create(properties?: google.devtools.cloudbuild.v1.IWorkerPool): google.devtools.cloudbuild.v1.WorkerPool;

Creates a new WorkerPool instance using the specified properties.

Parameter

Name	Description
properties	`IWorkerPool` Properties to set

Returns

Type	Description
google.devtools.cloudbuild.v1.WorkerPool	WorkerPool instance

decode(reader, length)

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

Decodes a WorkerPool 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.devtools.cloudbuild.v1.WorkerPool	WorkerPool

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.devtools.cloudbuild.v1.WorkerPool;

Decodes a WorkerPool 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.devtools.cloudbuild.v1.WorkerPool	WorkerPool

encode(message, writer)

public static encode(message: google.devtools.cloudbuild.v1.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.devtools.cloudbuild.v1.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.devtools.cloudbuild.v1.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
google.devtools.cloudbuild.v1.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.devtools.cloudbuild.v1.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	`google.devtools.cloudbuild.v1.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)	`null` if valid, otherwise the reason why it is not