Method: projects.locations.workerPools.list

Lists WorkerPools.

HTTP request

GET https://cloudbuild.googleapis.com/v1/{parent=projects/*/locations/*}/workerPools

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent of the collection of WorkerPools. Format: projects/{project}/locations/{location}.

Authorization requires the following IAM permission on the specified resource parent:

  • cloudbuild.workerpools.list

Query parameters

Parameters
pageSize

integer

The maximum number of WorkerPools to return. The service may return fewer than this value. If omitted, the server will use a sensible default.

pageToken

string

A page token, received from a previous workerPools.list call. Provide this to retrieve the subsequent page.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response containing existing WorkerPools.

JSON representation
{
  "workerPools": [
    {
      object (WorkerPool)
    }
  ],
  "nextPageToken": string
}
Fields
workerPools[]

object (WorkerPool)

WorkerPools for the specified project.

nextPageToken

string

Continuation token used to page through large result sets. Provide this value in a subsequent ListWorkerPoolsRequest to return the next page of results.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.