Lists queues. Queues are returned in lexicographical order.
Arguments
Parameters | |
---|---|
parent |
Required. The location name. For example:
|
filter |
|
pageSize |
Requested page size. The maximum page size is 9800. If unspecified, the page size will be the maximum. Fewer queues than requested might be returned, even if more queues exist; use the next_page_token in the response to determine if more queues exist.
|
pageToken |
A token identifying the page of results to return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListQueues method. It is an error to switch the value of the filter while iterating through pages.
|
readMask |
Optional. Read mask is used for a more granular control over what the API returns. If the mask is not present all fields will be returned except [Queue.stats]. [Queue.stats] will be returned only if it was explicitly specified in the mask.
|
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 ListQueuesResponse
.
Subworkflow snippet
Some fields might be optional or required. To identify required fields, refer to the API documentation.
YAML
- list: call: googleapis.cloudtasks.v2beta3.projects.locations.queues.list args: parent: ... filter: ... pageSize: ... pageToken: ... readMask: ... result: listResult
JSON
[ { "list": { "call": "googleapis.cloudtasks.v2beta3.projects.locations.queues.list", "args": { "parent": "...", "filter": "...", "pageSize": "...", "pageToken": "...", "readMask": "..." }, "result": "listResult" } } ]