Package com.google.cloud.tasks.v2beta3

Class 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.v2beta3.CloudTasks.ListQueues].
    Protobuf type google.cloud.tasks.v2beta3.ListQueuesRequest
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ListQueuesRequest.Builder
      Request message for [ListQueues][google.cloud.tasks.v2beta3.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

    • 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.v2beta3.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.v2beta3.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.v2beta3.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.v2beta3.ListQueuesResponse.next_page_token]
 returned from the previous call to
 [ListQueues][google.cloud.tasks.v2beta3.CloudTasks.ListQueues] method. It
 is an error to switch the value of the
 [filter][google.cloud.tasks.v2beta3.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.v2beta3.ListQueuesResponse.next_page_token]
 returned from the previous call to
 [ListQueues][google.cloud.tasks.v2beta3.CloudTasks.ListQueues] method. It
 is an error to switch the value of the
 [filter][google.cloud.tasks.v2beta3.ListQueuesRequest.filter] while
 iterating through pages.
        string page_token = 4;
        Specified by:
        getPageTokenBytes in interface ListQueuesRequestOrBuilder
        Returns:
        The bytes for pageToken.

      • 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];
        Specified by:
        hasReadMask in interface ListQueuesRequestOrBuilder
        Returns:
        Whether the readMask field is set.

      • getReadMask

        public com.google.protobuf.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];
        Specified by:
        getReadMask in interface ListQueuesRequestOrBuilder
        Returns:
        The readMask.

      • getReadMaskOrBuilder

        public com.google.protobuf.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];
        Specified by:
        getReadMaskOrBuilder in interface ListQueuesRequestOrBuilder

      • 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​(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

      • 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

      • 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