Class ListQueuesRequest.Builder (2.2.0)

publicstaticfinalclass ListQueuesRequest.BuilderextendsGeneratedMessageV3.Builder<ListQueuesRequest.Builder>implementsListQueuesRequestOrBuilder

Request message for ListQueues.

Protobuf type google.cloud.tasks.v2beta3.ListQueuesRequest

Inherited Members

Static Methods

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

publicListQueuesRequest.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
Name Description
value Object
Returns
Type Description
Overrides

build()

publicListQueuesRequestbuild()
Returns
Type Description

buildPartial()

publicListQueuesRequestbuildPartial()
Returns
Type Description

clear()

publicListQueuesRequest.Builderclear()
Returns
Type Description
Overrides

clearField(Descriptors.FieldDescriptor field)

publicListQueuesRequest.BuilderclearField(Descriptors.FieldDescriptorfield)
Parameter
Name Description
Returns
Type Description
Overrides

clearFilter()

publicListQueuesRequest.BuilderclearFilter()

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 filter = 2;

Returns
Type Description
ListQueuesRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

publicListQueuesRequest.BuilderclearOneof(Descriptors.OneofDescriptoroneof)
Parameter
Name Description
Returns
Type Description
Overrides

clearPageSize()

publicListQueuesRequest.BuilderclearPageSize()

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
ListQueuesRequest.Builder

This builder for chaining.

clearPageToken()

publicListQueuesRequest.BuilderclearPageToken()

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
ListQueuesRequest.Builder

This builder for chaining.

clearParent()

publicListQueuesRequest.BuilderclearParent()

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
ListQueuesRequest.Builder

This builder for chaining.

clearReadMask()

publicListQueuesRequest.BuilderclearReadMask()

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

clone()

publicListQueuesRequest.Builderclone()
Returns
Type Description
Overrides

getDefaultInstanceForType()

publicListQueuesRequestgetDefaultInstanceForType()
Returns
Type Description

getDescriptorForType()

publicDescriptors.DescriptorgetDescriptorForType()
Returns
Type Description
Overrides

getFilter()

publicStringgetFilter()

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 filter = 2;

Returns
Type Description
String

The filter.

getFilterBytes()

publicByteStringgetFilterBytes()

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 filter = 2;

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

publicintgetPageSize()

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()

publicStringgetPageToken()

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()

publicByteStringgetPageTokenBytes()

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
ByteString

The bytes for pageToken.

getParent()

publicStringgetParent()

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()

publicByteStringgetParentBytes()

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()

publicFieldMaskgetReadMask()

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.

getReadMaskBuilder()

publicFieldMask.BuildergetReadMaskBuilder()

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

getReadMaskOrBuilder()

publicFieldMaskOrBuildergetReadMaskOrBuilder()

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

hasReadMask()

publicbooleanhasReadMask()

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
boolean

Whether the readMask field is set.

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
Overrides

mergeFrom(ListQueuesRequest other)

publicListQueuesRequest.BuildermergeFrom(ListQueuesRequestother)
Parameter
Name Description
Returns
Type Description

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicListQueuesRequest.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Overrides Exceptions
Type Description

mergeFrom(Message other)

publicListQueuesRequest.BuildermergeFrom(Messageother)
Parameter
Name Description
other Message
Returns
Type Description
Overrides

mergeReadMask(FieldMask value)

publicListQueuesRequest.BuildermergeReadMask(FieldMaskvalue)

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];

Parameter
Name Description
value FieldMask
Returns
Type Description

mergeUnknownFields(UnknownFieldSet unknownFields)

publicfinalListQueuesRequest.BuildermergeUnknownFields(UnknownFieldSetunknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

publicListQueuesRequest.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
Name Description
value Object
Returns
Type Description
Overrides

setFilter(String value)

publicListQueuesRequest.BuildersetFilter(Stringvalue)

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 filter = 2;

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListQueuesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

publicListQueuesRequest.BuildersetFilterBytes(ByteStringvalue)

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 filter = 2;

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListQueuesRequest.Builder

This builder for chaining.

setPageSize(int value)

publicListQueuesRequest.BuildersetPageSize(intvalue)

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;

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListQueuesRequest.Builder

This builder for chaining.

setPageToken(String value)

publicListQueuesRequest.BuildersetPageToken(Stringvalue)

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;

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListQueuesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

publicListQueuesRequest.BuildersetPageTokenBytes(ByteStringvalue)

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;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListQueuesRequest.Builder

This builder for chaining.

setParent(String value)

publicListQueuesRequest.BuildersetParent(Stringvalue)

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

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListQueuesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

publicListQueuesRequest.BuildersetParentBytes(ByteStringvalue)

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

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

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
ListQueuesRequest.Builder

This builder for chaining.

setReadMask(FieldMask value)

publicListQueuesRequest.BuildersetReadMask(FieldMaskvalue)

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];

Parameter
Name Description
value FieldMask
Returns
Type Description

setReadMask(FieldMask.Builder builderForValue)

publicListQueuesRequest.BuildersetReadMask(FieldMask.BuilderbuilderForValue)

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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

publicListQueuesRequest.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)
Parameters
Name Description
index int
value Object
Returns
Type Description
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

publicfinalListQueuesRequest.BuildersetUnknownFields(UnknownFieldSetunknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Overrides

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月19日 UTC.