Package com.google.cloud.tasks.v2

Interface ListTasksRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ListTasksRequest, ListTasksRequest.Builder
    public interface ListTasksRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      int getPageSize()
      Maximum 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.
      Task.View getResponseView()
      The response_view specifies which subset of the [Task][google.cloud.tasks.v2.Task] will be returned.
      int getResponseViewValue()
      The response_view specifies which subset of the [Task][google.cloud.tasks.v2.Task] will be returned.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Method Detail

      • getParent

        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) = { ... }
        Returns:
        The parent.

      • getParentBytes

        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) = { ... }
        Returns:
        The bytes for parent.

      • getResponseViewValue

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

 By default response_view is [BASIC][google.cloud.tasks.v2.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.v2.Task.View.FULL] requires
 `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
 permission on the [Task][google.cloud.tasks.v2.Task] resource.
        .google.cloud.tasks.v2.Task.View response_view = 2;
        Returns:
        The enum numeric value on the wire for responseView.

      • getResponseView

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

 By default response_view is [BASIC][google.cloud.tasks.v2.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.v2.Task.View.FULL] requires
 `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
 permission on the [Task][google.cloud.tasks.v2.Task] resource.
        .google.cloud.tasks.v2.Task.View response_view = 2;
        Returns:
        The responseView.

      • getPageSize

        int getPageSize()
         Maximum page size.

 Fewer tasks than requested might be returned, even if more tasks exist; use
 [next_page_token][google.cloud.tasks.v2.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 = 3;
        Returns:
        The pageSize.

      • getPageToken

        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.ListTasksResponse.next_page_token]
 returned from the previous call to
 [ListTasks][google.cloud.tasks.v2.CloudTasks.ListTasks] method.

 The page token is valid for only 2 hours.
        string page_token = 4;
        Returns:
        The pageToken.

      • getPageTokenBytes

        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.ListTasksResponse.next_page_token]
 returned from the previous call to
 [ListTasks][google.cloud.tasks.v2.CloudTasks.ListTasks] method.

 The page token is valid for only 2 hours.
        string page_token = 4;
        Returns:
        The bytes for pageToken.