Method: projects.locations.workerPools.list

HTTP request
Path parameters
Query parameters
Request body
Response body
- JSON representation
Authorization scopes
Try it!

Lists WorkerPool s.

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

Parameters
`pageSize`	`integer` The maximum number of `WorkerPool` s 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.

pageSize

integer

The maximum number of WorkerPool s 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

Response containing existing WorkerPools .

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

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

Fields

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.

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 .