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