public final class ListQueuesRequest extends GeneratedMessageV3 implements ListQueuesRequestOrBuilder
Request message for
ListQueues.
Protobuf type google.cloud.tasks.v2beta3.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
public static final int FILTER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
READ_MASK_FIELD_NUMBER
public static final int READ_MASK_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static ListQueuesRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ListQueuesRequest.Builder newBuilder()
newBuilder(ListQueuesRequest prototype)
public static ListQueuesRequest.Builder newBuilder(ListQueuesRequest prototype)
public static ListQueuesRequest parseDelimitedFrom(InputStream input)
public static ListQueuesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ListQueuesRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListQueuesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ListQueuesRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListQueuesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListQueuesRequest parseFrom(CodedInputStream input)
public static ListQueuesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListQueuesRequest parseFrom(InputStream input)
public static ListQueuesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ListQueuesRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListQueuesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ListQueuesRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public ListQueuesRequest getDefaultInstanceForType()
getFilter()
public 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 "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()
public ByteString getFilterBytes()
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()
public 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 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
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()
public 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 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.
|
getParserForType()
public Parser<ListQueuesRequest> getParserForType()
Overrides
getReadMask()
public 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 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];
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hasReadMask()
public 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 |
| Type |
Description |
boolean |
Whether the readMask field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ListQueuesRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListQueuesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public ListQueuesRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
