Class ListQueuesRequest (2.52.0)

publicfinalclass ListQueuesRequestextendsGeneratedMessageV3implementsListQueuesRequestOrBuilder

Request message for ListQueues.

Protobuf type google.cloud.tasks.v2beta2.ListQueuesRequest

Inherited Members

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

Static Fields

FILTER_FIELD_NUMBER

publicstaticfinalintFILTER_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SIZE_FIELD_NUMBER

publicstaticfinalintPAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

publicstaticfinalintPAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

publicstaticfinalintPARENT_FIELD_NUMBER
Field Value
Type Description
int

READ_MASK_FIELD_NUMBER

publicstaticfinalintREAD_MASK_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticListQueuesRequestgetDefaultInstance()
Returns
Type Description
ListQueuesRequest

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

newBuilder()

publicstaticListQueuesRequest.BuildernewBuilder()
Returns
Type Description
ListQueuesRequest.Builder

newBuilder(ListQueuesRequest prototype)

publicstaticListQueuesRequest.BuildernewBuilder(ListQueuesRequestprototype)
Parameter
Name Description
prototype ListQueuesRequest
Returns
Type Description
ListQueuesRequest.Builder

parseDelimitedFrom(InputStream input)

publicstaticListQueuesRequestparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
ListQueuesRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticListQueuesRequestparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListQueuesRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

publicstaticListQueuesRequestparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListQueuesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticListQueuesRequestparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListQueuesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticListQueuesRequestparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
ListQueuesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticListQueuesRequestparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListQueuesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticListQueuesRequestparseFrom(CodedInputStreaminput)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListQueuesRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticListQueuesRequestparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListQueuesRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

publicstaticListQueuesRequestparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
ListQueuesRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticListQueuesRequestparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListQueuesRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

publicstaticListQueuesRequestparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListQueuesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticListQueuesRequestparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListQueuesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

publicstaticParser<ListQueuesRequest>parser()
Returns
Type Description
Parser<ListQueuesRequest>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

publicListQueuesRequestgetDefaultInstanceForType()
Returns
Type Description
ListQueuesRequest

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

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

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.

getParserForType()

publicParser<ListQueuesRequest>getParserForType()
Returns
Type Description
Parser<ListQueuesRequest>
Overrides

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.

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
FieldMaskOrBuilder

getSerializedSize()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

publicListQueuesRequest.BuildernewBuilderForType()
Returns
Type Description
ListQueuesRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedListQueuesRequest.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListQueuesRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

publicListQueuesRequest.BuildertoBuilder()
Returns
Type Description
ListQueuesRequest.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException

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.