Reference documentation and code samples for the Google Cloud Tasks V2beta3 Client class ListQueuesRequest.
Request message for ListQueues.
Generated from protobuf message google.cloud.tasks.v2beta3.ListQueuesRequest
Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The location name. For example: |
↳ filter |
string
|
↳ 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. |
↳ read_mask |
Google\Protobuf\FieldMask
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. |
getParent
Required. The location name.
For example: projects/PROJECT_ID/locations/LOCATION_ID
Returns | |
---|---|
Type | Description |
string |
setParent
Required. The location name.
For example: projects/PROJECT_ID/locations/LOCATION_ID
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$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.
Returns | |
---|---|
Type | Description |
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.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$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.
Returns | |
---|---|
Type | Description |
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.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$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.
Returns | |
---|---|
Type | Description |
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.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getReadMask
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.
Returns | |
---|---|
Type | Description |
Google\Protobuf\FieldMask|null |
hasReadMask
clearReadMask
setReadMask
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.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\FieldMask
|
Returns | |
---|---|
Type | Description |
$this |