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/queue.proto 18 19 package com.google.cloud.tasks.v2; 20 21 public interface QueueOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.tasks.v2.Queue) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Caller-specified and required in 31 * [CreateQueue][google.cloud.tasks.v2.CloudTasks.CreateQueue], after which it 32 * becomes output only. 33 * The queue name. 34 * The queue name must have the following format: 35 * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` 36 * * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), 37 * hyphens (-), colons (:), or periods (.). 38 * For more information, see 39 * [Identifying 40 * projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) 41 * * `LOCATION_ID` is the canonical ID for the queue's location. 42 * The list of available locations can be obtained by calling 43 * [ListLocations][google.cloud.location.Locations.ListLocations]. 44 * For more information, see https://cloud.google.com/about/locations/. 45 * * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or 46 * hyphens (-). The maximum length is 100 characters. 47 * </pre> 48 * 49 * <code>string name = 1;</code> 50 * 51 * @return The name. 52 */ getName()53 java.lang.String getName(); 54 /** 55 * 56 * 57 * <pre> 58 * Caller-specified and required in 59 * [CreateQueue][google.cloud.tasks.v2.CloudTasks.CreateQueue], after which it 60 * becomes output only. 61 * The queue name. 62 * The queue name must have the following format: 63 * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` 64 * * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), 65 * hyphens (-), colons (:), or periods (.). 66 * For more information, see 67 * [Identifying 68 * projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) 69 * * `LOCATION_ID` is the canonical ID for the queue's location. 70 * The list of available locations can be obtained by calling 71 * [ListLocations][google.cloud.location.Locations.ListLocations]. 72 * For more information, see https://cloud.google.com/about/locations/. 73 * * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or 74 * hyphens (-). The maximum length is 100 characters. 75 * </pre> 76 * 77 * <code>string name = 1;</code> 78 * 79 * @return The bytes for name. 80 */ getNameBytes()81 com.google.protobuf.ByteString getNameBytes(); 82 83 /** 84 * 85 * 86 * <pre> 87 * Overrides for 88 * [task-level 89 * app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing]. 90 * These settings apply only to 91 * [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest] in this 92 * queue. [Http tasks][google.cloud.tasks.v2.HttpRequest] are not affected. 93 * If set, `app_engine_routing_override` is used for all 94 * [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest] in the 95 * queue, no matter what the setting is for the [task-level 96 * app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing]. 97 * </pre> 98 * 99 * <code>.google.cloud.tasks.v2.AppEngineRouting app_engine_routing_override = 2;</code> 100 * 101 * @return Whether the appEngineRoutingOverride field is set. 102 */ hasAppEngineRoutingOverride()103 boolean hasAppEngineRoutingOverride(); 104 /** 105 * 106 * 107 * <pre> 108 * Overrides for 109 * [task-level 110 * app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing]. 111 * These settings apply only to 112 * [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest] in this 113 * queue. [Http tasks][google.cloud.tasks.v2.HttpRequest] are not affected. 114 * If set, `app_engine_routing_override` is used for all 115 * [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest] in the 116 * queue, no matter what the setting is for the [task-level 117 * app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing]. 118 * </pre> 119 * 120 * <code>.google.cloud.tasks.v2.AppEngineRouting app_engine_routing_override = 2;</code> 121 * 122 * @return The appEngineRoutingOverride. 123 */ getAppEngineRoutingOverride()124 com.google.cloud.tasks.v2.AppEngineRouting getAppEngineRoutingOverride(); 125 /** 126 * 127 * 128 * <pre> 129 * Overrides for 130 * [task-level 131 * app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing]. 132 * These settings apply only to 133 * [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest] in this 134 * queue. [Http tasks][google.cloud.tasks.v2.HttpRequest] are not affected. 135 * If set, `app_engine_routing_override` is used for all 136 * [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest] in the 137 * queue, no matter what the setting is for the [task-level 138 * app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing]. 139 * </pre> 140 * 141 * <code>.google.cloud.tasks.v2.AppEngineRouting app_engine_routing_override = 2;</code> 142 */ getAppEngineRoutingOverrideOrBuilder()143 com.google.cloud.tasks.v2.AppEngineRoutingOrBuilder getAppEngineRoutingOverrideOrBuilder(); 144 145 /** 146 * 147 * 148 * <pre> 149 * Rate limits for task dispatches. 150 * [rate_limits][google.cloud.tasks.v2.Queue.rate_limits] and 151 * [retry_config][google.cloud.tasks.v2.Queue.retry_config] are related 152 * because they both control task attempts. However they control task attempts 153 * in different ways: 154 * * [rate_limits][google.cloud.tasks.v2.Queue.rate_limits] controls the total 155 * rate of 156 * dispatches from a queue (i.e. all traffic dispatched from the 157 * queue, regardless of whether the dispatch is from a first 158 * attempt or a retry). 159 * * [retry_config][google.cloud.tasks.v2.Queue.retry_config] controls what 160 * happens to 161 * particular a task after its first attempt fails. That is, 162 * [retry_config][google.cloud.tasks.v2.Queue.retry_config] controls task 163 * retries (the second attempt, third attempt, etc). 164 * The queue's actual dispatch rate is the result of: 165 * * Number of tasks in the queue 166 * * User-specified throttling: 167 * [rate_limits][google.cloud.tasks.v2.Queue.rate_limits], 168 * [retry_config][google.cloud.tasks.v2.Queue.retry_config], and the 169 * [queue's state][google.cloud.tasks.v2.Queue.state]. 170 * * System throttling due to `429` (Too Many Requests) or `503` (Service 171 * Unavailable) responses from the worker, high error rates, or to smooth 172 * sudden large traffic spikes. 173 * </pre> 174 * 175 * <code>.google.cloud.tasks.v2.RateLimits rate_limits = 3;</code> 176 * 177 * @return Whether the rateLimits field is set. 178 */ hasRateLimits()179 boolean hasRateLimits(); 180 /** 181 * 182 * 183 * <pre> 184 * Rate limits for task dispatches. 185 * [rate_limits][google.cloud.tasks.v2.Queue.rate_limits] and 186 * [retry_config][google.cloud.tasks.v2.Queue.retry_config] are related 187 * because they both control task attempts. However they control task attempts 188 * in different ways: 189 * * [rate_limits][google.cloud.tasks.v2.Queue.rate_limits] controls the total 190 * rate of 191 * dispatches from a queue (i.e. all traffic dispatched from the 192 * queue, regardless of whether the dispatch is from a first 193 * attempt or a retry). 194 * * [retry_config][google.cloud.tasks.v2.Queue.retry_config] controls what 195 * happens to 196 * particular a task after its first attempt fails. That is, 197 * [retry_config][google.cloud.tasks.v2.Queue.retry_config] controls task 198 * retries (the second attempt, third attempt, etc). 199 * The queue's actual dispatch rate is the result of: 200 * * Number of tasks in the queue 201 * * User-specified throttling: 202 * [rate_limits][google.cloud.tasks.v2.Queue.rate_limits], 203 * [retry_config][google.cloud.tasks.v2.Queue.retry_config], and the 204 * [queue's state][google.cloud.tasks.v2.Queue.state]. 205 * * System throttling due to `429` (Too Many Requests) or `503` (Service 206 * Unavailable) responses from the worker, high error rates, or to smooth 207 * sudden large traffic spikes. 208 * </pre> 209 * 210 * <code>.google.cloud.tasks.v2.RateLimits rate_limits = 3;</code> 211 * 212 * @return The rateLimits. 213 */ getRateLimits()214 com.google.cloud.tasks.v2.RateLimits getRateLimits(); 215 /** 216 * 217 * 218 * <pre> 219 * Rate limits for task dispatches. 220 * [rate_limits][google.cloud.tasks.v2.Queue.rate_limits] and 221 * [retry_config][google.cloud.tasks.v2.Queue.retry_config] are related 222 * because they both control task attempts. However they control task attempts 223 * in different ways: 224 * * [rate_limits][google.cloud.tasks.v2.Queue.rate_limits] controls the total 225 * rate of 226 * dispatches from a queue (i.e. all traffic dispatched from the 227 * queue, regardless of whether the dispatch is from a first 228 * attempt or a retry). 229 * * [retry_config][google.cloud.tasks.v2.Queue.retry_config] controls what 230 * happens to 231 * particular a task after its first attempt fails. That is, 232 * [retry_config][google.cloud.tasks.v2.Queue.retry_config] controls task 233 * retries (the second attempt, third attempt, etc). 234 * The queue's actual dispatch rate is the result of: 235 * * Number of tasks in the queue 236 * * User-specified throttling: 237 * [rate_limits][google.cloud.tasks.v2.Queue.rate_limits], 238 * [retry_config][google.cloud.tasks.v2.Queue.retry_config], and the 239 * [queue's state][google.cloud.tasks.v2.Queue.state]. 240 * * System throttling due to `429` (Too Many Requests) or `503` (Service 241 * Unavailable) responses from the worker, high error rates, or to smooth 242 * sudden large traffic spikes. 243 * </pre> 244 * 245 * <code>.google.cloud.tasks.v2.RateLimits rate_limits = 3;</code> 246 */ getRateLimitsOrBuilder()247 com.google.cloud.tasks.v2.RateLimitsOrBuilder getRateLimitsOrBuilder(); 248 249 /** 250 * 251 * 252 * <pre> 253 * Settings that determine the retry behavior. 254 * * For tasks created using Cloud Tasks: the queue-level retry settings 255 * apply to all tasks in the queue that were created using Cloud Tasks. 256 * Retry settings cannot be set on individual tasks. 257 * * For tasks created using the App Engine SDK: the queue-level retry 258 * settings apply to all tasks in the queue which do not have retry settings 259 * explicitly set on the task and were created by the App Engine SDK. See 260 * [App Engine 261 * documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). 262 * </pre> 263 * 264 * <code>.google.cloud.tasks.v2.RetryConfig retry_config = 4;</code> 265 * 266 * @return Whether the retryConfig field is set. 267 */ hasRetryConfig()268 boolean hasRetryConfig(); 269 /** 270 * 271 * 272 * <pre> 273 * Settings that determine the retry behavior. 274 * * For tasks created using Cloud Tasks: the queue-level retry settings 275 * apply to all tasks in the queue that were created using Cloud Tasks. 276 * Retry settings cannot be set on individual tasks. 277 * * For tasks created using the App Engine SDK: the queue-level retry 278 * settings apply to all tasks in the queue which do not have retry settings 279 * explicitly set on the task and were created by the App Engine SDK. See 280 * [App Engine 281 * documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). 282 * </pre> 283 * 284 * <code>.google.cloud.tasks.v2.RetryConfig retry_config = 4;</code> 285 * 286 * @return The retryConfig. 287 */ getRetryConfig()288 com.google.cloud.tasks.v2.RetryConfig getRetryConfig(); 289 /** 290 * 291 * 292 * <pre> 293 * Settings that determine the retry behavior. 294 * * For tasks created using Cloud Tasks: the queue-level retry settings 295 * apply to all tasks in the queue that were created using Cloud Tasks. 296 * Retry settings cannot be set on individual tasks. 297 * * For tasks created using the App Engine SDK: the queue-level retry 298 * settings apply to all tasks in the queue which do not have retry settings 299 * explicitly set on the task and were created by the App Engine SDK. See 300 * [App Engine 301 * documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). 302 * </pre> 303 * 304 * <code>.google.cloud.tasks.v2.RetryConfig retry_config = 4;</code> 305 */ getRetryConfigOrBuilder()306 com.google.cloud.tasks.v2.RetryConfigOrBuilder getRetryConfigOrBuilder(); 307 308 /** 309 * 310 * 311 * <pre> 312 * Output only. The state of the queue. 313 * `state` can only be changed by called 314 * [PauseQueue][google.cloud.tasks.v2.CloudTasks.PauseQueue], 315 * [ResumeQueue][google.cloud.tasks.v2.CloudTasks.ResumeQueue], or uploading 316 * [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). 317 * [UpdateQueue][google.cloud.tasks.v2.CloudTasks.UpdateQueue] cannot be used 318 * to change `state`. 319 * </pre> 320 * 321 * <code>.google.cloud.tasks.v2.Queue.State state = 5;</code> 322 * 323 * @return The enum numeric value on the wire for state. 324 */ getStateValue()325 int getStateValue(); 326 /** 327 * 328 * 329 * <pre> 330 * Output only. The state of the queue. 331 * `state` can only be changed by called 332 * [PauseQueue][google.cloud.tasks.v2.CloudTasks.PauseQueue], 333 * [ResumeQueue][google.cloud.tasks.v2.CloudTasks.ResumeQueue], or uploading 334 * [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). 335 * [UpdateQueue][google.cloud.tasks.v2.CloudTasks.UpdateQueue] cannot be used 336 * to change `state`. 337 * </pre> 338 * 339 * <code>.google.cloud.tasks.v2.Queue.State state = 5;</code> 340 * 341 * @return The state. 342 */ getState()343 com.google.cloud.tasks.v2.Queue.State getState(); 344 345 /** 346 * 347 * 348 * <pre> 349 * Output only. The last time this queue was purged. 350 * All tasks that were [created][google.cloud.tasks.v2.Task.create_time] 351 * before this time were purged. 352 * A queue can be purged using 353 * [PurgeQueue][google.cloud.tasks.v2.CloudTasks.PurgeQueue], the [App Engine 354 * Task Queue SDK, or the Cloud 355 * Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue). 356 * Purge time will be truncated to the nearest microsecond. Purge 357 * time will be unset if the queue has never been purged. 358 * </pre> 359 * 360 * <code>.google.protobuf.Timestamp purge_time = 6;</code> 361 * 362 * @return Whether the purgeTime field is set. 363 */ hasPurgeTime()364 boolean hasPurgeTime(); 365 /** 366 * 367 * 368 * <pre> 369 * Output only. The last time this queue was purged. 370 * All tasks that were [created][google.cloud.tasks.v2.Task.create_time] 371 * before this time were purged. 372 * A queue can be purged using 373 * [PurgeQueue][google.cloud.tasks.v2.CloudTasks.PurgeQueue], the [App Engine 374 * Task Queue SDK, or the Cloud 375 * Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue). 376 * Purge time will be truncated to the nearest microsecond. Purge 377 * time will be unset if the queue has never been purged. 378 * </pre> 379 * 380 * <code>.google.protobuf.Timestamp purge_time = 6;</code> 381 * 382 * @return The purgeTime. 383 */ getPurgeTime()384 com.google.protobuf.Timestamp getPurgeTime(); 385 /** 386 * 387 * 388 * <pre> 389 * Output only. The last time this queue was purged. 390 * All tasks that were [created][google.cloud.tasks.v2.Task.create_time] 391 * before this time were purged. 392 * A queue can be purged using 393 * [PurgeQueue][google.cloud.tasks.v2.CloudTasks.PurgeQueue], the [App Engine 394 * Task Queue SDK, or the Cloud 395 * Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue). 396 * Purge time will be truncated to the nearest microsecond. Purge 397 * time will be unset if the queue has never been purged. 398 * </pre> 399 * 400 * <code>.google.protobuf.Timestamp purge_time = 6;</code> 401 */ getPurgeTimeOrBuilder()402 com.google.protobuf.TimestampOrBuilder getPurgeTimeOrBuilder(); 403 404 /** 405 * 406 * 407 * <pre> 408 * Configuration options for writing logs to 409 * [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this 410 * field is unset, then no logs are written. 411 * </pre> 412 * 413 * <code>.google.cloud.tasks.v2.StackdriverLoggingConfig stackdriver_logging_config = 9;</code> 414 * 415 * @return Whether the stackdriverLoggingConfig field is set. 416 */ hasStackdriverLoggingConfig()417 boolean hasStackdriverLoggingConfig(); 418 /** 419 * 420 * 421 * <pre> 422 * Configuration options for writing logs to 423 * [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this 424 * field is unset, then no logs are written. 425 * </pre> 426 * 427 * <code>.google.cloud.tasks.v2.StackdriverLoggingConfig stackdriver_logging_config = 9;</code> 428 * 429 * @return The stackdriverLoggingConfig. 430 */ getStackdriverLoggingConfig()431 com.google.cloud.tasks.v2.StackdriverLoggingConfig getStackdriverLoggingConfig(); 432 /** 433 * 434 * 435 * <pre> 436 * Configuration options for writing logs to 437 * [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this 438 * field is unset, then no logs are written. 439 * </pre> 440 * 441 * <code>.google.cloud.tasks.v2.StackdriverLoggingConfig stackdriver_logging_config = 9;</code> 442 */ 443 com.google.cloud.tasks.v2.StackdriverLoggingConfigOrBuilder getStackdriverLoggingConfigOrBuilder()444 getStackdriverLoggingConfigOrBuilder(); 445 } 446