com.google.cloud.tasks.v2

Class ListQueuesRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.tasks.v2.ListQueuesRequest

All Implemented Interfaces:

ListQueuesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class ListQueuesRequest
extends com.google.protobuf.GeneratedMessageV3
implements ListQueuesRequestOrBuilder

 Request message for
 [ListQueues][google.cloud.tasks.v2.CloudTasks.ListQueues].
 

Protobuf type google.cloud.tasks.v2.ListQueuesRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListQueuesRequest.Builder Request message for [ListQueues][google.cloud.tasks.v2.CloudTasks.ListQueues].

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	FILTER_FIELD_NUMBER
static int	PAGE_SIZE_FIELD_NUMBER
static int	PAGE_TOKEN_FIELD_NUMBER
static int	PARENT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static ListQueuesRequest	getDefaultInstance()
ListQueuesRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getFilter() `filter` can be used to specify a subset of queues.
com.google.protobuf.ByteString	getFilterBytes() `filter` can be used to specify a subset of queues.
int	getPageSize() Requested page size.
String	getPageToken() A token identifying the page of results to return.
com.google.protobuf.ByteString	getPageTokenBytes() A token identifying the page of results to return.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
com.google.protobuf.Parser<ListQueuesRequest>	getParserForType()
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ListQueuesRequest.Builder	newBuilder()
static ListQueuesRequest.Builder	newBuilder(ListQueuesRequest prototype)
ListQueuesRequest.Builder	newBuilderForType()
protected ListQueuesRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ListQueuesRequest	parseDelimitedFrom(InputStream input)
static ListQueuesRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListQueuesRequest	parseFrom(byte[] data)
static ListQueuesRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListQueuesRequest	parseFrom(ByteBuffer data)
static ListQueuesRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListQueuesRequest	parseFrom(com.google.protobuf.ByteString data)
static ListQueuesRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListQueuesRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static ListQueuesRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ListQueuesRequest	parseFrom(InputStream input)
static ListQueuesRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ListQueuesRequest>	parser()
ListQueuesRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER

See Also:

Constant Field Values

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER

See Also:

Constant Field Values

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER

See Also:

Constant Field Values

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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) = { ... }

Specified by:

getParent in interface ListQueuesRequestOrBuilder

Returns:

The parent.

getParentBytes

public com.google.protobuf.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) = { ... }

Specified by:

getParentBytes in interface ListQueuesRequestOrBuilder

Returns:

The bytes for parent.

getFilter

public String getFilter()

 `filter` can be used to specify a subset of queues. Any
 [Queue][google.cloud.tasks.v2.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](https://cloud.google.com/logging/docs/view/advanced_filters).

 Sample filter "state: PAUSED".

 Note that using filters might cause fewer queues than the
 requested page_size to be returned.
 

string filter = 2;

Specified by:

getFilter in interface ListQueuesRequestOrBuilder

Returns:

The filter.

getFilterBytes

public com.google.protobuf.ByteString getFilterBytes()

 `filter` can be used to specify a subset of queues. Any
 [Queue][google.cloud.tasks.v2.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](https://cloud.google.com/logging/docs/view/advanced_filters).

 Sample filter "state: PAUSED".

 Note that using filters might cause fewer queues than the
 requested page_size to be returned.
 

string filter = 2;

Specified by:

getFilterBytes in interface ListQueuesRequestOrBuilder

Returns:

The bytes for filter.

getPageSize

public int 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][google.cloud.tasks.v2.ListQueuesResponse.next_page_token]
 in the response to determine if more queues exist.
 

int32 page_size = 3;

Specified by:

getPageSize in interface ListQueuesRequestOrBuilder

Returns:

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][google.cloud.tasks.v2.ListQueuesResponse.next_page_token]
 returned from the previous call to
 [ListQueues][google.cloud.tasks.v2.CloudTasks.ListQueues] method. It is an
 error to switch the value of the
 [filter][google.cloud.tasks.v2.ListQueuesRequest.filter] while iterating
 through pages.
 

string page_token = 4;

Specified by:

getPageToken in interface ListQueuesRequestOrBuilder

Returns:

The pageToken.

getPageTokenBytes

public com.google.protobuf.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][google.cloud.tasks.v2.ListQueuesResponse.next_page_token]
 returned from the previous call to
 [ListQueues][google.cloud.tasks.v2.CloudTasks.ListQueues] method. It is an
 error to switch the value of the
 [filter][google.cloud.tasks.v2.ListQueuesRequest.filter] while iterating
 through pages.
 

string page_token = 4;

Specified by:

getPageTokenBytes in interface ListQueuesRequestOrBuilder

Returns:

The bytes for pageToken.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static ListQueuesRequest parseFrom(ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListQueuesRequest parseFrom(ByteBuffer data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListQueuesRequest parseFrom(com.google.protobuf.ByteString data)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListQueuesRequest parseFrom(com.google.protobuf.ByteString data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListQueuesRequest parseFrom(byte[] data)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListQueuesRequest parseFrom(byte[] data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ListQueuesRequest parseFrom(InputStream input)
                                   throws IOException

Throws:

IOException

parseFrom

public static ListQueuesRequest parseFrom(InputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException

Throws:

IOException

parseDelimitedFrom

public static ListQueuesRequest parseDelimitedFrom(InputStream input)
                                            throws IOException

Throws:

IOException

parseDelimitedFrom

public static ListQueuesRequest parseDelimitedFrom(InputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws IOException

Throws:

IOException

parseFrom

public static ListQueuesRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                   throws IOException

Throws:

IOException

parseFrom

public static ListQueuesRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException

Throws:

IOException

newBuilderForType

public ListQueuesRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ListQueuesRequest.Builder newBuilder()

newBuilder

public static ListQueuesRequest.Builder newBuilder(ListQueuesRequest prototype)

toBuilder

public ListQueuesRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ListQueuesRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ListQueuesRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<ListQueuesRequest> parser()

getParserForType

public com.google.protobuf.Parser<ListQueuesRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public ListQueuesRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder