Package com.google.cloud.tasks.v2beta2

Class ListTasksRequest

  • All Implemented Interfaces:
    ListTasksRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ListTasksRequest
extends com.google.protobuf.GeneratedMessageV3
implements ListTasksRequestOrBuilder
     Request message for listing tasks using
 [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks].
    Protobuf type google.cloud.tasks.v2beta2.ListTasksRequest
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ListTasksRequest.Builder
      Request message for listing tasks using [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks].

      • 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 Description
      static int PAGE_SIZE_FIELD_NUMBER  
      static int PAGE_TOKEN_FIELD_NUMBER  
      static int PARENT_FIELD_NUMBER  
      static int RESPONSE_VIEW_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 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 queue name. For example:
 `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParent in interface ListTasksRequestOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public com.google.protobuf.ByteString getParentBytes()
         Required. The queue name. For example:
 `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParentBytes in interface ListTasksRequestOrBuilder
        Returns:
        The bytes for parent.

      • getResponseViewValue

        public int getResponseViewValue()
         The response_view specifies which subset of the
 [Task][google.cloud.tasks.v2beta2.Task] will be returned.

 By default response_view is
 [BASIC][google.cloud.tasks.v2beta2.Task.View.BASIC]; not all information is
 retrieved by default because some data, such as payloads, might be
 desirable to return only when needed because of its large size or because
 of the sensitivity of data that it contains.

 Authorization for [FULL][google.cloud.tasks.v2beta2.Task.View.FULL]
 requires `cloudtasks.tasks.fullView` [Google
 IAM](https://cloud.google.com/iam/) permission on the
 [Task][google.cloud.tasks.v2beta2.Task] resource.
        .google.cloud.tasks.v2beta2.Task.View response_view = 2;
        Specified by:
        getResponseViewValue in interface ListTasksRequestOrBuilder
        Returns:
        The enum numeric value on the wire for responseView.

      • getResponseView

        public Task.View getResponseView()
         The response_view specifies which subset of the
 [Task][google.cloud.tasks.v2beta2.Task] will be returned.

 By default response_view is
 [BASIC][google.cloud.tasks.v2beta2.Task.View.BASIC]; not all information is
 retrieved by default because some data, such as payloads, might be
 desirable to return only when needed because of its large size or because
 of the sensitivity of data that it contains.

 Authorization for [FULL][google.cloud.tasks.v2beta2.Task.View.FULL]
 requires `cloudtasks.tasks.fullView` [Google
 IAM](https://cloud.google.com/iam/) permission on the
 [Task][google.cloud.tasks.v2beta2.Task] resource.
        .google.cloud.tasks.v2beta2.Task.View response_view = 2;
        Specified by:
        getResponseView in interface ListTasksRequestOrBuilder
        Returns:
        The responseView.

      • getPageSize

        public int getPageSize()
         Maximum page size.

 Fewer tasks than requested might be returned, even if more tasks exist; use
 [next_page_token][google.cloud.tasks.v2beta2.ListTasksResponse.next_page_token]
 in the response to determine if more tasks exist.

 The maximum page size is 1000. If unspecified, the page size will be the
 maximum.
        int32 page_size = 4;
        Specified by:
        getPageSize in interface ListTasksRequestOrBuilder
        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.v2beta2.ListTasksResponse.next_page_token]
 returned from the previous call to
 [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks] method.

 The page token is valid for only 2 hours.
        string page_token = 5;
        Specified by:
        getPageToken in interface ListTasksRequestOrBuilder
        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.v2beta2.ListTasksResponse.next_page_token]
 returned from the previous call to
 [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks] method.

 The page token is valid for only 2 hours.
        string page_token = 5;
        Specified by:
        getPageTokenBytes in interface ListTasksRequestOrBuilder
        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 ListTasksRequest parseFrom​(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListTasksRequest parseFrom​(ByteBuffer data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListTasksRequest parseFrom​(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListTasksRequest parseFrom​(com.google.protobuf.ByteString data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListTasksRequest parseFrom​(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListTasksRequest parseFrom​(byte[] data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListTasksRequest parseFrom​(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException
        Throws:
        IOException

      • newBuilderForType

        public ListTasksRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public ListTasksRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected ListTasksRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<ListTasksRequest> 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 ListTasksRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder