Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class protos.google.devtools.cloudbuild.v1.CreateWorkerPoolRequest (3.1.2)

Represents a CreateWorkerPoolRequest.

Package

@google-cloud/cloudbuild

Constructors

(constructor)(properties)

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

Constructs a new CreateWorkerPoolRequest.

Parameter

Name	Description
properties	`google.devtools.cloudbuild.v1.ICreateWorkerPoolRequest` Properties to set

Properties

parent

public parent: string;

CreateWorkerPoolRequest parent.

validateOnly

public validateOnly: boolean;

CreateWorkerPoolRequest validateOnly.

workerPool

public workerPool?: (google.devtools.cloudbuild.v1.IWorkerPool|null);

CreateWorkerPoolRequest workerPool.

workerPoolId

public workerPoolId: string;

CreateWorkerPoolRequest workerPoolId.

Methods

create(properties)

public static create(properties?: google.devtools.cloudbuild.v1.ICreateWorkerPoolRequest): google.devtools.cloudbuild.v1.CreateWorkerPoolRequest;

Creates a new CreateWorkerPoolRequest instance using the specified properties.

Parameter

Name	Description
properties	`google.devtools.cloudbuild.v1.ICreateWorkerPoolRequest` Properties to set

Returns

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

decode(reader, length)

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

Decodes a CreateWorkerPoolRequest 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.CreateWorkerPoolRequest	CreateWorkerPoolRequest

decodeDelimited(reader)

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

Decodes a CreateWorkerPoolRequest 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.CreateWorkerPoolRequest	CreateWorkerPoolRequest

encode(message, writer)

public static encode(message: google.devtools.cloudbuild.v1.ICreateWorkerPoolRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified CreateWorkerPoolRequest message. Does not implicitly messages.

Parameters

Name	Description
message	`google.devtools.cloudbuild.v1.ICreateWorkerPoolRequest` CreateWorkerPoolRequest 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.ICreateWorkerPoolRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`google.devtools.cloudbuild.v1.ICreateWorkerPoolRequest` CreateWorkerPoolRequest 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.CreateWorkerPoolRequest;

Creates a CreateWorkerPoolRequest 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.CreateWorkerPoolRequest	CreateWorkerPoolRequest

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for CreateWorkerPoolRequest

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 CreateWorkerPoolRequest to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.devtools.cloudbuild.v1.CreateWorkerPoolRequest` CreateWorkerPoolRequest
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 CreateWorkerPoolRequest 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