Method: projects.locations.workerPools.patch

Updates a WorkerPool.

HTTP request

PATCH https://cloudbuild.googleapis.com/v1/{workerPool.name=projects/*/locations/*/workerPools/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
workerPool.name

string

Output only. The resource name of the WorkerPool, with format projects/{project}/locations/{location}/workerPools/{workerPool}. The value of {workerPool} is provided by workerPoolId in workerPools.create request and the value of {location} is determined by the endpoint accessed.

Query parameters

Parameters
updateMask

string (FieldMask format)

A mask specifying which fields in workerPool to update.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

validateOnly

boolean

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

Request body

The request body contains an instance of WorkerPool.

Response body

If successful, the response body contains an instance of Operation.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.