com.google.cloud.tasks.v2beta2

Interface ListQueuesRequestOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

ListQueuesRequest, ListQueuesRequest.Builder

public interface ListQueuesRequestOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getFilter() `filter` can be used to specify a subset of queues.
ByteString	getFilterBytes() `filter` can be used to specify a subset of queues.
int	getPageSize() Requested page size.
String	getPageToken() A token identifying the page of results to return.
ByteString	getPageTokenBytes() A token identifying the page of results to return.
String	getParent() Required.
ByteString	getParentBytes() Required.
FieldMask	getReadMask() Optional.
FieldMaskOrBuilder	getReadMaskOrBuilder() Optional.
boolean	hasReadMask() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getParent

String getParent()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The parent.

getParentBytes

ByteString getParentBytes()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The bytes for parent.

getFilter

String getFilter()

 `filter` can be used to specify a subset of queues. Any [Queue][google.cloud.tasks.v2beta2.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](https://cloud.google.com/logging/docs/view/advanced_filters).
 Sample filter "app_engine_http_target: *".
 Note that using filters might cause fewer queues than the
 requested_page size to be returned.
 

string filter = 2;

Returns:

The filter.

getFilterBytes

ByteString getFilterBytes()

 `filter` can be used to specify a subset of queues. Any [Queue][google.cloud.tasks.v2beta2.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](https://cloud.google.com/logging/docs/view/advanced_filters).
 Sample filter "app_engine_http_target: *".
 Note that using filters might cause fewer queues than the
 requested_page size to be returned.
 

string filter = 2;

Returns:

The bytes for filter.

getPageSize

int 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][google.cloud.tasks.v2beta2.ListQueuesResponse.next_page_token] in the
 response to determine if more queues exist.
 

int32 page_size = 3;

Returns:

The pageSize.

getPageToken

String 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][google.cloud.tasks.v2beta2.ListQueuesResponse.next_page_token] returned
 from the previous call to [ListQueues][google.cloud.tasks.v2beta2.CloudTasks.ListQueues]
 method. It is an error to switch the value of the
 [filter][google.cloud.tasks.v2beta2.ListQueuesRequest.filter] while iterating through pages.
 

string page_token = 4;

Returns:

The pageToken.

getPageTokenBytes

ByteString getPageTokenBytes()

 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.v2beta2.ListQueuesResponse.next_page_token] returned
 from the previous call to [ListQueues][google.cloud.tasks.v2beta2.CloudTasks.ListQueues]
 method. It is an error to switch the value of the
 [filter][google.cloud.tasks.v2beta2.ListQueuesRequest.filter] while iterating through pages.
 

string page_token = 4;

Returns:

The bytes for pageToken.

hasReadMask

boolean hasReadMask()

 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.
 

.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the readMask field is set.

getReadMask

FieldMask 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.
 

.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The readMask.

getReadMaskOrBuilder

FieldMaskOrBuilder getReadMaskOrBuilder()

 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.
 

.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];