Interface ListQueuesRequestOrBuilder (2.37.0)

public interface ListQueuesRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract String 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 "app_engine_http_target: *".

Note that using filters might cause fewer queues than the requested_page size to be returned.

string filter = 2;

Returns
Type	Description
`String`	The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

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
Type	Description
`ByteString`	The bytes for filter.

getPageSize()

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

int32 page_size = 3;

Returns
Type	Description
`int`	The pageSize.

getPageToken()

public abstract 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 returned from the previous call to ListQueues method. It is an error to switch the value of the filter while iterating through pages.

string page_token = 4;

Returns
Type	Description
`String`	The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

A token identifying the page of results to return.

string page_token = 4;

Returns
Type	Description
`ByteString`	The bytes for pageToken.

getParent()

public abstract 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
Type	Description
`String`	The parent.

getParentBytes()

public abstract 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
Type	Description
`ByteString`	The bytes for parent.

getReadMask()

public abstract 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
Type	Description
`FieldMask`	The readMask.

getReadMaskOrBuilder()

public abstract FieldMaskOrBuilder getReadMaskOrBuilder()

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

Returns
Type	Description
`FieldMaskOrBuilder`

hasReadMask()

public abstract boolean hasReadMask()

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

Returns
Type	Description
`boolean`	Whether the readMask field is set.