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 ListQueuesRequestOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.tasks.v2.ListQueuesRequest) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Required. The location name. 31 * For example: `projects/PROJECT_ID/locations/LOCATION_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 location name. 46 * For example: `projects/PROJECT_ID/locations/LOCATION_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 * `filter` can be used to specify a subset of queues. Any [Queue][google.cloud.tasks.v2.Queue] 62 * field can be used as a filter and several operators as supported. 63 * For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as 64 * described in 65 * [Stackdriver's Advanced Logs 66 * Filters](https://cloud.google.com/logging/docs/view/advanced_filters). 67 * Sample filter "state: PAUSED". 68 * Note that using filters might cause fewer queues than the 69 * requested page_size to be returned. 70 * </pre> 71 * 72 * <code>string filter = 2;</code> 73 * 74 * @return The filter. 75 */ getFilter()76 java.lang.String getFilter(); 77 /** 78 * 79 * 80 * <pre> 81 * `filter` can be used to specify a subset of queues. Any [Queue][google.cloud.tasks.v2.Queue] 82 * field can be used as a filter and several operators as supported. 83 * For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as 84 * described in 85 * [Stackdriver's Advanced Logs 86 * Filters](https://cloud.google.com/logging/docs/view/advanced_filters). 87 * Sample filter "state: PAUSED". 88 * Note that using filters might cause fewer queues than the 89 * requested page_size to be returned. 90 * </pre> 91 * 92 * <code>string filter = 2;</code> 93 * 94 * @return The bytes for filter. 95 */ getFilterBytes()96 com.google.protobuf.ByteString getFilterBytes(); 97 98 /** 99 * 100 * 101 * <pre> 102 * Requested page size. 103 * The maximum page size is 9800. If unspecified, the page size will 104 * be the maximum. Fewer queues than requested might be returned, 105 * even if more queues exist; use the 106 * [next_page_token][google.cloud.tasks.v2.ListQueuesResponse.next_page_token] in the 107 * response to determine if more queues exist. 108 * </pre> 109 * 110 * <code>int32 page_size = 3;</code> 111 * 112 * @return The pageSize. 113 */ getPageSize()114 int getPageSize(); 115 116 /** 117 * 118 * 119 * <pre> 120 * A token identifying the page of results to return. 121 * To request the first page results, page_token must be empty. To 122 * request the next page of results, page_token must be the value of 123 * [next_page_token][google.cloud.tasks.v2.ListQueuesResponse.next_page_token] returned 124 * from the previous call to [ListQueues][google.cloud.tasks.v2.CloudTasks.ListQueues] 125 * method. It is an error to switch the value of the 126 * [filter][google.cloud.tasks.v2.ListQueuesRequest.filter] while iterating through pages. 127 * </pre> 128 * 129 * <code>string page_token = 4;</code> 130 * 131 * @return The pageToken. 132 */ getPageToken()133 java.lang.String getPageToken(); 134 /** 135 * 136 * 137 * <pre> 138 * A token identifying the page of results to return. 139 * To request the first page results, page_token must be empty. To 140 * request the next page of results, page_token must be the value of 141 * [next_page_token][google.cloud.tasks.v2.ListQueuesResponse.next_page_token] returned 142 * from the previous call to [ListQueues][google.cloud.tasks.v2.CloudTasks.ListQueues] 143 * method. It is an error to switch the value of the 144 * [filter][google.cloud.tasks.v2.ListQueuesRequest.filter] while iterating through pages. 145 * </pre> 146 * 147 * <code>string page_token = 4;</code> 148 * 149 * @return The bytes for pageToken. 150 */ getPageTokenBytes()151 com.google.protobuf.ByteString getPageTokenBytes(); 152 } 153