public sealed class ListQueuesRequest : IMessage<ListQueuesRequest>, IEquatable<ListQueuesRequest>, IDeepCloneable<ListQueuesRequest>, IBufferMessage, IMessage, IPageRequest
Reference documentation and code samples for the Google Cloud Tasks v2 API class ListQueuesRequest.
Request message for [ListQueues][google.cloud.tasks.v2.CloudTasks.ListQueues].
Implements
IMessageListQueuesRequest, IEquatableListQueuesRequest, IDeepCloneableListQueuesRequest, IBufferMessage, IMessage, IPageRequestNamespace
Google.Cloud.Tasks.V2Assembly
Google.Cloud.Tasks.V2.dll
Constructors
ListQueuesRequest()
public ListQueuesRequest()
ListQueuesRequest(ListQueuesRequest)
public ListQueuesRequest(ListQueuesRequest other)
Parameter | |
---|---|
Name | Description |
other |
ListQueuesRequest |
Properties
Filter
public string Filter { get; set; }
filter
can be used to specify a subset of queues. Any
[Queue][google.cloud.tasks.v2.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.
Property Value | |
---|---|
Type | Description |
string |
PageSize
public int PageSize { get; set; }
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][google.cloud.tasks.v2.ListQueuesResponse.next_page_token] in the response to determine if more queues exist.
Property Value | |
---|---|
Type | Description |
int |
PageToken
public string PageToken { get; set; }
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][google.cloud.tasks.v2.ListQueuesResponse.next_page_token] returned from the previous call to [ListQueues][google.cloud.tasks.v2.CloudTasks.ListQueues] method. It is an error to switch the value of the [filter][google.cloud.tasks.v2.ListQueuesRequest.filter] while iterating through pages.
Property Value | |
---|---|
Type | Description |
string |
Parent
public string Parent { get; set; }
Required. The location name.
For example: projects/PROJECT_ID/locations/LOCATION_ID
Property Value | |
---|---|
Type | Description |
string |
ParentAsLocationName
public LocationName ParentAsLocationName { get; set; }
LocationName-typed view over the Parent resource name property.
Property Value | |
---|---|
Type | Description |
LocationName |