Method: googleapis.cloudbuild.v1.projects.locations.workerPools.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists WorkerPool
s.
Arguments
Parameters |
parent |
string
Required. The parent of the collection of WorkerPools . Format: projects/{project}/locations/{location} .
|
pageSize |
integer (int32 format)
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 ListWorkerPools call. Provide this to retrieve the subsequent page.
|
Raised exceptions
Exceptions |
ConnectionError |
In case of a network problem (such as DNS failure or refused connection). |
HttpError |
If the response status is >= 400 (excluding 429 and 503). |
TimeoutError |
If a long-running operation takes longer to finish than the specified timeout limit. |
TypeError |
If an operation or function receives an argument of the wrong type. |
ValueError |
If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout. |
Response
If successful, the response contains an instance of ListWorkerPoolsResponse
.
Subworkflow snippet
Some fields might be optional or required.
To identify required fields, refer to the API documentation.
YAML
- list:
call: googleapis.cloudbuild.v1.projects.locations.workerPools.list
args:
parent: ...
pageSize: ...
pageToken: ...
result: listResult
JSON
[
{
"list": {
"call": "googleapis.cloudbuild.v1.projects.locations.workerPools.list",
"args": {
"parent": "...",
"pageSize": "...",
"pageToken": "..."
},
"result": "listResult"
}
}
]
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-09 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Method: googleapis.cloudbuild.v1.projects.locations.workerPools.list\n\nLists `WorkerPool`s.\n\nArguments\n---------\n\nRaised exceptions\n-----------------\n\nResponse\n--------\n\nIf successful, the response contains an instance of [`ListWorkerPoolsResponse`](/workflows/docs/reference/googleapis/cloudbuild/v1/Overview#ListWorkerPoolsResponse).\n\nSubworkflow snippet\n-------------------\n\nSome fields might be optional or required.\nTo identify required fields, refer to the [API documentation](https://cloud.google.com/build/docs/api/reference/rest/v1/projects.locations.workerPools/list). \n\n### YAML\n\n```yaml\n- list:\n call: googleapis.cloudbuild.v1.projects.locations.workerPools.list\n args:\n parent: ...\n pageSize: ...\n pageToken: ...\n result: listResult\n```\n\n### JSON\n\n```json\n[\n {\n \"list\": {\n \"call\": \"googleapis.cloudbuild.v1.projects.locations.workerPools.list\",\n \"args\": {\n \"parent\": \"...\",\n \"pageSize\": \"...\",\n \"pageToken\": \"...\"\n },\n \"result\": \"listResult\"\n }\n }\n]\n```"]]