1 /* 2 * Copyright 2020 Google LLC 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * https://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 // Generated by the protocol buffer compiler. DO NOT EDIT! 17 // source: google/cloud/tasks/v2/cloudtasks.proto 18 19 package com.google.cloud.tasks.v2; 20 21 public interface ListTasksRequestOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.tasks.v2.ListTasksRequest) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Required. The queue name. For example: 31 * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` 32 * </pre> 33 * 34 * <code> 35 * string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... } 36 * </code> 37 * 38 * @return The parent. 39 */ getParent()40 java.lang.String getParent(); 41 /** 42 * 43 * 44 * <pre> 45 * Required. The queue name. For example: 46 * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` 47 * </pre> 48 * 49 * <code> 50 * string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... } 51 * </code> 52 * 53 * @return The bytes for parent. 54 */ getParentBytes()55 com.google.protobuf.ByteString getParentBytes(); 56 57 /** 58 * 59 * 60 * <pre> 61 * The response_view specifies which subset of the [Task][google.cloud.tasks.v2.Task] will be 62 * returned. 63 * By default response_view is [BASIC][google.cloud.tasks.v2.Task.View.BASIC]; not all 64 * information is retrieved by default because some data, such as 65 * payloads, might be desirable to return only when needed because 66 * of its large size or because of the sensitivity of data that it 67 * contains. 68 * Authorization for [FULL][google.cloud.tasks.v2.Task.View.FULL] requires 69 * `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) 70 * permission on the [Task][google.cloud.tasks.v2.Task] resource. 71 * </pre> 72 * 73 * <code>.google.cloud.tasks.v2.Task.View response_view = 2;</code> 74 * 75 * @return The enum numeric value on the wire for responseView. 76 */ getResponseViewValue()77 int getResponseViewValue(); 78 /** 79 * 80 * 81 * <pre> 82 * The response_view specifies which subset of the [Task][google.cloud.tasks.v2.Task] will be 83 * returned. 84 * By default response_view is [BASIC][google.cloud.tasks.v2.Task.View.BASIC]; not all 85 * information is retrieved by default because some data, such as 86 * payloads, might be desirable to return only when needed because 87 * of its large size or because of the sensitivity of data that it 88 * contains. 89 * Authorization for [FULL][google.cloud.tasks.v2.Task.View.FULL] requires 90 * `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) 91 * permission on the [Task][google.cloud.tasks.v2.Task] resource. 92 * </pre> 93 * 94 * <code>.google.cloud.tasks.v2.Task.View response_view = 2;</code> 95 * 96 * @return The responseView. 97 */ getResponseView()98 com.google.cloud.tasks.v2.Task.View getResponseView(); 99 100 /** 101 * 102 * 103 * <pre> 104 * Maximum page size. 105 * Fewer tasks than requested might be returned, even if more tasks exist; use 106 * [next_page_token][google.cloud.tasks.v2.ListTasksResponse.next_page_token] in the response to 107 * determine if more tasks exist. 108 * The maximum page size is 1000. If unspecified, the page size will be the 109 * maximum. 110 * </pre> 111 * 112 * <code>int32 page_size = 3;</code> 113 * 114 * @return The pageSize. 115 */ getPageSize()116 int getPageSize(); 117 118 /** 119 * 120 * 121 * <pre> 122 * A token identifying the page of results to return. 123 * To request the first page results, page_token must be empty. To 124 * request the next page of results, page_token must be the value of 125 * [next_page_token][google.cloud.tasks.v2.ListTasksResponse.next_page_token] returned 126 * from the previous call to [ListTasks][google.cloud.tasks.v2.CloudTasks.ListTasks] 127 * method. 128 * The page token is valid for only 2 hours. 129 * </pre> 130 * 131 * <code>string page_token = 4;</code> 132 * 133 * @return The pageToken. 134 */ getPageToken()135 java.lang.String getPageToken(); 136 /** 137 * 138 * 139 * <pre> 140 * A token identifying the page of results to return. 141 * To request the first page results, page_token must be empty. To 142 * request the next page of results, page_token must be the value of 143 * [next_page_token][google.cloud.tasks.v2.ListTasksResponse.next_page_token] returned 144 * from the previous call to [ListTasks][google.cloud.tasks.v2.CloudTasks.ListTasks] 145 * method. 146 * The page token is valid for only 2 hours. 147 * </pre> 148 * 149 * <code>string page_token = 4;</code> 150 * 151 * @return The bytes for pageToken. 152 */ getPageTokenBytes()153 com.google.protobuf.ByteString getPageTokenBytes(); 154 } 155