publicfinalclass ListQueuesRequestextendsGeneratedMessageV3implementsListQueuesRequestOrBuilder
Request message for ListQueues.
Protobuf type google.cloud.tasks.v2beta3.ListQueuesRequest
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()
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()
newBuilder()
publicstaticListQueuesRequest.BuildernewBuilder()
newBuilder(ListQueuesRequest prototype)
publicstaticListQueuesRequest.BuildernewBuilder(ListQueuesRequestprototype)
publicstaticListQueuesRequestparseDelimitedFrom(InputStreaminput)
publicstaticListQueuesRequestparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
parseFrom(byte[] data)
publicstaticListQueuesRequestparseFrom(byte[]data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
publicstaticListQueuesRequestparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
parseFrom(ByteString data)
publicstaticListQueuesRequestparseFrom(ByteStringdata)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
publicstaticListQueuesRequestparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
publicstaticListQueuesRequestparseFrom(CodedInputStreaminput)
publicstaticListQueuesRequestparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
publicstaticListQueuesRequestparseFrom(InputStreaminput)
publicstaticListQueuesRequestparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
parseFrom(ByteBuffer data)
publicstaticListQueuesRequestparseFrom(ByteBufferdata)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
publicstaticListQueuesRequestparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
parser()
publicstaticParser<ListQueuesRequest>parser()
Methods
equals(Object obj)
publicbooleanequals(Objectobj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
publicListQueuesRequestgetDefaultInstanceForType()
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 "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()
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()
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()
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];
getSerializedSize()
publicintgetSerializedSize()
| Returns |
| Type |
Description |
int |
Overrides
getUnknownFields()
publicfinalUnknownFieldSetgetUnknownFields()
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()
| Returns |
| Type |
Description |
int |
Overrides
internalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Overrides
isInitialized()
publicfinalbooleanisInitialized()
Overrides
newBuilderForType()
publicListQueuesRequest.BuildernewBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protectedListQueuesRequest.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
| Returns |
| Type |
Description |
Object |
Overrides
toBuilder()
publicListQueuesRequest.BuildertoBuilder()
writeTo(CodedOutputStream output)
publicvoidwriteTo(CodedOutputStreamoutput)
Overrides