Google Cloud Build V1 Client - Class UpdateWorkerPoolRequest (0.16.3)

Reference documentation and code samples for the Google Cloud Build V1 Client class UpdateWorkerPoolRequest.

Request to update a WorkerPool.

Generated from protobuf message google.devtools.cloudbuild.v1.UpdateWorkerPoolRequest

Namespace

Google \ Cloud \ Build \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ worker_pool Google\Cloud\Build\V1\WorkerPool

Required. The WorkerPool to update. The name field is used to identify the WorkerPool to update. Format: projects/{project}/locations/{location}/workerPools/{workerPool}.
↳ update_mask Google\Protobuf\FieldMask

A mask specifying which fields in worker_pool to update.
↳ validate_only bool

If set, validate the request and preview the response, but do not actually post it.

getWorkerPool

Required. The WorkerPool to update.

The name field is used to identify the WorkerPool to update. Format: projects/{project}/locations/{location}/workerPools/{workerPool}.

Returns
Type Description
Google\Cloud\Build\V1\WorkerPool|null

hasWorkerPool

clearWorkerPool

setWorkerPool

Required. The WorkerPool to update.

The name field is used to identify the WorkerPool to update. Format: projects/{project}/locations/{location}/workerPools/{workerPool}.

Parameter
Name Description
var Google\Cloud\Build\V1\WorkerPool
Returns
Type Description
$this

getUpdateMask

A mask specifying which fields in worker_pool to update.

Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

A mask specifying which fields in worker_pool to update.

Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this

getValidateOnly

If set, validate the request and preview the response, but do not actually post it.

Returns
Type Description
bool

setValidateOnly

If set, validate the request and preview the response, but do not actually post it.

Parameter
Name Description
var bool
Returns
Type Description
$this