Method: projects.locations.queues.list

Lists queues.

Queues are returned in lexicographical order.

HTTP request

GET https://cloudtasks.googleapis.com/v2beta3/{parent=projects/*/locations/*}/queues

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID

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

  • cloudtasks.queues.list

Query parameters

Parameters
filter

string

filter can be used to specify a subset of queues. Any Queue field can be used as a filter and several operators as supported. For example: <=, <, >=, >, !=, =, :. The filter syntax is the same as described in Stackdriver's Advanced Logs Filters.

Sample filter "state: PAUSED".

Note that using filters might cause fewer queues than the requested pageSize to be returned.
pageSize

integer

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 nextPageToken in the response to determine if more queues exist.
pageToken

string

A token identifying the page of results to return.

To request the first page results, pageToken must be empty. To request the next page of results, pageToken must be the value of nextPageToken returned from the previous call to queues.list method. It is an error to switch the value of the filter while iterating through pages.
readMask

string (FieldMask format)

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.

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

Request body

The request body must be empty.

Response body

Response message for queues.list.

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

JSON representation 
{
  "queues": [
    {
      object (Queue)
    }
  ],
  "nextPageToken": string
}
Fields
queues[]

object (Queue)

The list of queues.
nextPageToken

string

A token to retrieve next page of results.

To return the next page of results, call queues.list with this value as the pageToken.

If the nextPageToken is empty, there are no more results.

The page token is valid for only 2 hours.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.