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/v2beta2/queue.proto 18 19 package com.google.cloud.tasks.v2beta2; 20 21 public interface QueueOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.tasks.v2beta2.Queue) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Caller-specified and required in 31 * [CreateQueue][google.cloud.tasks.v2beta2.CloudTasks.CreateQueue], after 32 * which it 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.v2beta2.CloudTasks.CreateQueue], after 60 * which it 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 * App Engine HTTP target. 88 * An App Engine queue is a queue that has an 89 * [AppEngineHttpTarget][google.cloud.tasks.v2beta2.AppEngineHttpTarget]. 90 * </pre> 91 * 92 * <code>.google.cloud.tasks.v2beta2.AppEngineHttpTarget app_engine_http_target = 3;</code> 93 * 94 * @return Whether the appEngineHttpTarget field is set. 95 */ hasAppEngineHttpTarget()96 boolean hasAppEngineHttpTarget(); 97 /** 98 * 99 * 100 * <pre> 101 * App Engine HTTP target. 102 * An App Engine queue is a queue that has an 103 * [AppEngineHttpTarget][google.cloud.tasks.v2beta2.AppEngineHttpTarget]. 104 * </pre> 105 * 106 * <code>.google.cloud.tasks.v2beta2.AppEngineHttpTarget app_engine_http_target = 3;</code> 107 * 108 * @return The appEngineHttpTarget. 109 */ getAppEngineHttpTarget()110 com.google.cloud.tasks.v2beta2.AppEngineHttpTarget getAppEngineHttpTarget(); 111 /** 112 * 113 * 114 * <pre> 115 * App Engine HTTP target. 116 * An App Engine queue is a queue that has an 117 * [AppEngineHttpTarget][google.cloud.tasks.v2beta2.AppEngineHttpTarget]. 118 * </pre> 119 * 120 * <code>.google.cloud.tasks.v2beta2.AppEngineHttpTarget app_engine_http_target = 3;</code> 121 */ getAppEngineHttpTargetOrBuilder()122 com.google.cloud.tasks.v2beta2.AppEngineHttpTargetOrBuilder getAppEngineHttpTargetOrBuilder(); 123 124 /** 125 * 126 * 127 * <pre> 128 * Pull target. 129 * A pull queue is a queue that has a 130 * [PullTarget][google.cloud.tasks.v2beta2.PullTarget]. 131 * </pre> 132 * 133 * <code>.google.cloud.tasks.v2beta2.PullTarget pull_target = 4;</code> 134 * 135 * @return Whether the pullTarget field is set. 136 */ hasPullTarget()137 boolean hasPullTarget(); 138 /** 139 * 140 * 141 * <pre> 142 * Pull target. 143 * A pull queue is a queue that has a 144 * [PullTarget][google.cloud.tasks.v2beta2.PullTarget]. 145 * </pre> 146 * 147 * <code>.google.cloud.tasks.v2beta2.PullTarget pull_target = 4;</code> 148 * 149 * @return The pullTarget. 150 */ getPullTarget()151 com.google.cloud.tasks.v2beta2.PullTarget getPullTarget(); 152 /** 153 * 154 * 155 * <pre> 156 * Pull target. 157 * A pull queue is a queue that has a 158 * [PullTarget][google.cloud.tasks.v2beta2.PullTarget]. 159 * </pre> 160 * 161 * <code>.google.cloud.tasks.v2beta2.PullTarget pull_target = 4;</code> 162 */ getPullTargetOrBuilder()163 com.google.cloud.tasks.v2beta2.PullTargetOrBuilder getPullTargetOrBuilder(); 164 165 /** 166 * 167 * 168 * <pre> 169 * Rate limits for task dispatches. 170 * [rate_limits][google.cloud.tasks.v2beta2.Queue.rate_limits] and 171 * [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] are related 172 * because they both control task attempts however they control how tasks are 173 * attempted in different ways: 174 * * [rate_limits][google.cloud.tasks.v2beta2.Queue.rate_limits] controls the 175 * total rate of 176 * dispatches from a queue (i.e. all traffic dispatched from the 177 * queue, regardless of whether the dispatch is from a first 178 * attempt or a retry). 179 * * [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] controls 180 * what happens to 181 * particular a task after its first attempt fails. That is, 182 * [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] controls 183 * task retries (the second attempt, third attempt, etc). 184 * </pre> 185 * 186 * <code>.google.cloud.tasks.v2beta2.RateLimits rate_limits = 5;</code> 187 * 188 * @return Whether the rateLimits field is set. 189 */ hasRateLimits()190 boolean hasRateLimits(); 191 /** 192 * 193 * 194 * <pre> 195 * Rate limits for task dispatches. 196 * [rate_limits][google.cloud.tasks.v2beta2.Queue.rate_limits] and 197 * [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] are related 198 * because they both control task attempts however they control how tasks are 199 * attempted in different ways: 200 * * [rate_limits][google.cloud.tasks.v2beta2.Queue.rate_limits] controls the 201 * total rate of 202 * dispatches from a queue (i.e. all traffic dispatched from the 203 * queue, regardless of whether the dispatch is from a first 204 * attempt or a retry). 205 * * [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] controls 206 * what happens to 207 * particular a task after its first attempt fails. That is, 208 * [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] controls 209 * task retries (the second attempt, third attempt, etc). 210 * </pre> 211 * 212 * <code>.google.cloud.tasks.v2beta2.RateLimits rate_limits = 5;</code> 213 * 214 * @return The rateLimits. 215 */ getRateLimits()216 com.google.cloud.tasks.v2beta2.RateLimits getRateLimits(); 217 /** 218 * 219 * 220 * <pre> 221 * Rate limits for task dispatches. 222 * [rate_limits][google.cloud.tasks.v2beta2.Queue.rate_limits] and 223 * [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] are related 224 * because they both control task attempts however they control how tasks are 225 * attempted in different ways: 226 * * [rate_limits][google.cloud.tasks.v2beta2.Queue.rate_limits] controls the 227 * total rate of 228 * dispatches from a queue (i.e. all traffic dispatched from the 229 * queue, regardless of whether the dispatch is from a first 230 * attempt or a retry). 231 * * [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] controls 232 * what happens to 233 * particular a task after its first attempt fails. That is, 234 * [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] controls 235 * task retries (the second attempt, third attempt, etc). 236 * </pre> 237 * 238 * <code>.google.cloud.tasks.v2beta2.RateLimits rate_limits = 5;</code> 239 */ getRateLimitsOrBuilder()240 com.google.cloud.tasks.v2beta2.RateLimitsOrBuilder getRateLimitsOrBuilder(); 241 242 /** 243 * 244 * 245 * <pre> 246 * Settings that determine the retry behavior. 247 * * For tasks created using Cloud Tasks: the queue-level retry settings 248 * apply to all tasks in the queue that were created using Cloud Tasks. 249 * Retry settings cannot be set on individual tasks. 250 * * For tasks created using the App Engine SDK: the queue-level retry 251 * settings apply to all tasks in the queue which do not have retry settings 252 * explicitly set on the task and were created by the App Engine SDK. See 253 * [App Engine 254 * documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). 255 * </pre> 256 * 257 * <code>.google.cloud.tasks.v2beta2.RetryConfig retry_config = 6;</code> 258 * 259 * @return Whether the retryConfig field is set. 260 */ hasRetryConfig()261 boolean hasRetryConfig(); 262 /** 263 * 264 * 265 * <pre> 266 * Settings that determine the retry behavior. 267 * * For tasks created using Cloud Tasks: the queue-level retry settings 268 * apply to all tasks in the queue that were created using Cloud Tasks. 269 * Retry settings cannot be set on individual tasks. 270 * * For tasks created using the App Engine SDK: the queue-level retry 271 * settings apply to all tasks in the queue which do not have retry settings 272 * explicitly set on the task and were created by the App Engine SDK. See 273 * [App Engine 274 * documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). 275 * </pre> 276 * 277 * <code>.google.cloud.tasks.v2beta2.RetryConfig retry_config = 6;</code> 278 * 279 * @return The retryConfig. 280 */ getRetryConfig()281 com.google.cloud.tasks.v2beta2.RetryConfig getRetryConfig(); 282 /** 283 * 284 * 285 * <pre> 286 * Settings that determine the retry behavior. 287 * * For tasks created using Cloud Tasks: the queue-level retry settings 288 * apply to all tasks in the queue that were created using Cloud Tasks. 289 * Retry settings cannot be set on individual tasks. 290 * * For tasks created using the App Engine SDK: the queue-level retry 291 * settings apply to all tasks in the queue which do not have retry settings 292 * explicitly set on the task and were created by the App Engine SDK. See 293 * [App Engine 294 * documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). 295 * </pre> 296 * 297 * <code>.google.cloud.tasks.v2beta2.RetryConfig retry_config = 6;</code> 298 */ getRetryConfigOrBuilder()299 com.google.cloud.tasks.v2beta2.RetryConfigOrBuilder getRetryConfigOrBuilder(); 300 301 /** 302 * 303 * 304 * <pre> 305 * Output only. The state of the queue. 306 * `state` can only be changed by calling 307 * [PauseQueue][google.cloud.tasks.v2beta2.CloudTasks.PauseQueue], 308 * [ResumeQueue][google.cloud.tasks.v2beta2.CloudTasks.ResumeQueue], or 309 * uploading 310 * [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). 311 * [UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue] cannot be 312 * used to change `state`. 313 * </pre> 314 * 315 * <code>.google.cloud.tasks.v2beta2.Queue.State state = 7;</code> 316 * 317 * @return The enum numeric value on the wire for state. 318 */ getStateValue()319 int getStateValue(); 320 /** 321 * 322 * 323 * <pre> 324 * Output only. The state of the queue. 325 * `state` can only be changed by calling 326 * [PauseQueue][google.cloud.tasks.v2beta2.CloudTasks.PauseQueue], 327 * [ResumeQueue][google.cloud.tasks.v2beta2.CloudTasks.ResumeQueue], or 328 * uploading 329 * [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). 330 * [UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue] cannot be 331 * used to change `state`. 332 * </pre> 333 * 334 * <code>.google.cloud.tasks.v2beta2.Queue.State state = 7;</code> 335 * 336 * @return The state. 337 */ getState()338 com.google.cloud.tasks.v2beta2.Queue.State getState(); 339 340 /** 341 * 342 * 343 * <pre> 344 * Output only. The last time this queue was purged. 345 * All tasks that were [created][google.cloud.tasks.v2beta2.Task.create_time] 346 * before this time were purged. 347 * A queue can be purged using 348 * [PurgeQueue][google.cloud.tasks.v2beta2.CloudTasks.PurgeQueue], the [App 349 * Engine Task Queue SDK, or the Cloud 350 * Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue). 351 * Purge time will be truncated to the nearest microsecond. Purge 352 * time will be unset if the queue has never been purged. 353 * </pre> 354 * 355 * <code>.google.protobuf.Timestamp purge_time = 8;</code> 356 * 357 * @return Whether the purgeTime field is set. 358 */ hasPurgeTime()359 boolean hasPurgeTime(); 360 /** 361 * 362 * 363 * <pre> 364 * Output only. The last time this queue was purged. 365 * All tasks that were [created][google.cloud.tasks.v2beta2.Task.create_time] 366 * before this time were purged. 367 * A queue can be purged using 368 * [PurgeQueue][google.cloud.tasks.v2beta2.CloudTasks.PurgeQueue], the [App 369 * Engine Task Queue SDK, or the Cloud 370 * Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue). 371 * Purge time will be truncated to the nearest microsecond. Purge 372 * time will be unset if the queue has never been purged. 373 * </pre> 374 * 375 * <code>.google.protobuf.Timestamp purge_time = 8;</code> 376 * 377 * @return The purgeTime. 378 */ getPurgeTime()379 com.google.protobuf.Timestamp getPurgeTime(); 380 /** 381 * 382 * 383 * <pre> 384 * Output only. The last time this queue was purged. 385 * All tasks that were [created][google.cloud.tasks.v2beta2.Task.create_time] 386 * before this time were purged. 387 * A queue can be purged using 388 * [PurgeQueue][google.cloud.tasks.v2beta2.CloudTasks.PurgeQueue], the [App 389 * Engine Task Queue SDK, or the Cloud 390 * Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue). 391 * Purge time will be truncated to the nearest microsecond. Purge 392 * time will be unset if the queue has never been purged. 393 * </pre> 394 * 395 * <code>.google.protobuf.Timestamp purge_time = 8;</code> 396 */ getPurgeTimeOrBuilder()397 com.google.protobuf.TimestampOrBuilder getPurgeTimeOrBuilder(); 398 399 /** 400 * 401 * 402 * <pre> 403 * The maximum amount of time that a task will be retained in 404 * this queue. 405 * Queues created by Cloud Tasks have a default `task_ttl` of 31 days. 406 * After a task has lived for `task_ttl`, the task will be deleted 407 * regardless of whether it was dispatched or not. 408 * The `task_ttl` for queues created via queue.yaml/xml is equal to the 409 * maximum duration because there is a 410 * [storage quota](https://cloud.google.com/appengine/quotas#Task_Queue) for 411 * these queues. To view the maximum valid duration, see the documentation for 412 * [Duration][google.protobuf.Duration]. 413 * </pre> 414 * 415 * <code>.google.protobuf.Duration task_ttl = 9;</code> 416 * 417 * @return Whether the taskTtl field is set. 418 */ hasTaskTtl()419 boolean hasTaskTtl(); 420 /** 421 * 422 * 423 * <pre> 424 * The maximum amount of time that a task will be retained in 425 * this queue. 426 * Queues created by Cloud Tasks have a default `task_ttl` of 31 days. 427 * After a task has lived for `task_ttl`, the task will be deleted 428 * regardless of whether it was dispatched or not. 429 * The `task_ttl` for queues created via queue.yaml/xml is equal to the 430 * maximum duration because there is a 431 * [storage quota](https://cloud.google.com/appengine/quotas#Task_Queue) for 432 * these queues. To view the maximum valid duration, see the documentation for 433 * [Duration][google.protobuf.Duration]. 434 * </pre> 435 * 436 * <code>.google.protobuf.Duration task_ttl = 9;</code> 437 * 438 * @return The taskTtl. 439 */ getTaskTtl()440 com.google.protobuf.Duration getTaskTtl(); 441 /** 442 * 443 * 444 * <pre> 445 * The maximum amount of time that a task will be retained in 446 * this queue. 447 * Queues created by Cloud Tasks have a default `task_ttl` of 31 days. 448 * After a task has lived for `task_ttl`, the task will be deleted 449 * regardless of whether it was dispatched or not. 450 * The `task_ttl` for queues created via queue.yaml/xml is equal to the 451 * maximum duration because there is a 452 * [storage quota](https://cloud.google.com/appengine/quotas#Task_Queue) for 453 * these queues. To view the maximum valid duration, see the documentation for 454 * [Duration][google.protobuf.Duration]. 455 * </pre> 456 * 457 * <code>.google.protobuf.Duration task_ttl = 9;</code> 458 */ getTaskTtlOrBuilder()459 com.google.protobuf.DurationOrBuilder getTaskTtlOrBuilder(); 460 461 /** 462 * 463 * 464 * <pre> 465 * The task tombstone time to live (TTL). 466 * After a task is deleted or completed, the task's tombstone is 467 * retained for the length of time specified by `tombstone_ttl`. 468 * The tombstone is used by task de-duplication; another task with the same 469 * name can't be created until the tombstone has expired. For more information 470 * about task de-duplication, see the documentation for 471 * [CreateTaskRequest][google.cloud.tasks.v2beta2.CreateTaskRequest.task]. 472 * Queues created by Cloud Tasks have a default `tombstone_ttl` of 1 hour. 473 * </pre> 474 * 475 * <code>.google.protobuf.Duration tombstone_ttl = 10;</code> 476 * 477 * @return Whether the tombstoneTtl field is set. 478 */ hasTombstoneTtl()479 boolean hasTombstoneTtl(); 480 /** 481 * 482 * 483 * <pre> 484 * The task tombstone time to live (TTL). 485 * After a task is deleted or completed, the task's tombstone is 486 * retained for the length of time specified by `tombstone_ttl`. 487 * The tombstone is used by task de-duplication; another task with the same 488 * name can't be created until the tombstone has expired. For more information 489 * about task de-duplication, see the documentation for 490 * [CreateTaskRequest][google.cloud.tasks.v2beta2.CreateTaskRequest.task]. 491 * Queues created by Cloud Tasks have a default `tombstone_ttl` of 1 hour. 492 * </pre> 493 * 494 * <code>.google.protobuf.Duration tombstone_ttl = 10;</code> 495 * 496 * @return The tombstoneTtl. 497 */ getTombstoneTtl()498 com.google.protobuf.Duration getTombstoneTtl(); 499 /** 500 * 501 * 502 * <pre> 503 * The task tombstone time to live (TTL). 504 * After a task is deleted or completed, the task's tombstone is 505 * retained for the length of time specified by `tombstone_ttl`. 506 * The tombstone is used by task de-duplication; another task with the same 507 * name can't be created until the tombstone has expired. For more information 508 * about task de-duplication, see the documentation for 509 * [CreateTaskRequest][google.cloud.tasks.v2beta2.CreateTaskRequest.task]. 510 * Queues created by Cloud Tasks have a default `tombstone_ttl` of 1 hour. 511 * </pre> 512 * 513 * <code>.google.protobuf.Duration tombstone_ttl = 10;</code> 514 */ getTombstoneTtlOrBuilder()515 com.google.protobuf.DurationOrBuilder getTombstoneTtlOrBuilder(); 516 517 /** 518 * 519 * 520 * <pre> 521 * Output only. The realtime, informational statistics for a queue. In order 522 * to receive the statistics the caller should include this field in the 523 * FieldMask. 524 * </pre> 525 * 526 * <code> 527 * .google.cloud.tasks.v2beta2.QueueStats stats = 16 [(.google.api.field_behavior) = OUTPUT_ONLY]; 528 * </code> 529 * 530 * @return Whether the stats field is set. 531 */ hasStats()532 boolean hasStats(); 533 /** 534 * 535 * 536 * <pre> 537 * Output only. The realtime, informational statistics for a queue. In order 538 * to receive the statistics the caller should include this field in the 539 * FieldMask. 540 * </pre> 541 * 542 * <code> 543 * .google.cloud.tasks.v2beta2.QueueStats stats = 16 [(.google.api.field_behavior) = OUTPUT_ONLY]; 544 * </code> 545 * 546 * @return The stats. 547 */ getStats()548 com.google.cloud.tasks.v2beta2.QueueStats getStats(); 549 /** 550 * 551 * 552 * <pre> 553 * Output only. The realtime, informational statistics for a queue. In order 554 * to receive the statistics the caller should include this field in the 555 * FieldMask. 556 * </pre> 557 * 558 * <code> 559 * .google.cloud.tasks.v2beta2.QueueStats stats = 16 [(.google.api.field_behavior) = OUTPUT_ONLY]; 560 * </code> 561 */ getStatsOrBuilder()562 com.google.cloud.tasks.v2beta2.QueueStatsOrBuilder getStatsOrBuilder(); 563 getTargetTypeCase()564 public com.google.cloud.tasks.v2beta2.Queue.TargetTypeCase getTargetTypeCase(); 565 } 566