Reference documentation and code samples for the Google Cloud Tasks V2 Client class ListQueuesRequest.
Request message for ListQueues .
Generated from protobuf message google.cloud.tasks.v2.ListQueuesRequest
Namespace
Google \ Cloud \ Tasks \ V2Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID
↳ 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 page_size to be returned.
↳ page_size
int
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.
↳ page_token
string
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.
getParent
Required. The location name.
For example: projects/PROJECT_ID/locations/LOCATION_ID
string
setParent
Required. The location name.
For example: projects/PROJECT_ID/locations/LOCATION_ID
var
string
$this
getFilter
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 page_size to be returned.
string
setFilter
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 page_size to be returned.
var
string
$this
getPageSize
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.
int
setPageSize
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.
var
int
$this
getPageToken
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.
string
setPageToken
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.
var
string
$this
static::build
parent
string
Required. The location name.
For example: projects/PROJECT_ID/locations/LOCATION_ID
Please see CloudTasksClient::locationName()
for help formatting this field.
