google-cloud-tasks-v2beta3 0.19.0 → 0.20.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -319,11 +319,10 @@ module Google
319
319
  # a task's ID is identical to that of an existing task or a task
320
320
  # that was deleted or executed recently then the call will fail
321
321
  # with [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS].
322
- # If the task's queue was created using Cloud Tasks, then another task with
323
- # the same name can't be created for ~1 hour after the original task was
324
- # deleted or executed. If the task's queue was created using queue.yaml or
325
- # queue.xml, then another task with the same name can't be created
326
- # for ~9 days after the original task was deleted or executed.
322
+ # The IDs of deleted tasks are not immediately available for reuse. It can
323
+ # take up to 24 hours (or 9 days if the task's queue was created using a
324
+ # queue.yaml or queue.xml) for the task ID to be released and made available
325
+ # again.
327
326
  #
328
327
  # Because there is an extra lookup cost to identify duplicate task
329
328
  # names, these {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#create_task CreateTask}
@@ -354,6 +353,32 @@ module Google
354
353
  extend ::Google::Protobuf::MessageExts::ClassMethods
355
354
  end
356
355
 
356
+ # Request message for [BatchCreateTasks].
357
+ # @!attribute [rw] parent
358
+ # @return [::String]
359
+ # Required. The queue name. For example:
360
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
361
+ #
362
+ # The queue must already exist.
363
+ # @!attribute [rw] requests
364
+ # @return [::Array<::Google::Cloud::Tasks::V2beta3::CreateTaskRequest>]
365
+ # Required. The list of requests to create tasks.
366
+ # The queue specified in parent field of each CreateTaskRequest will be
367
+ # the same. This validation happens on the client side as well as in the
368
+ # handler.
369
+ # BatchCreateTasksRequest.parent will also be the same value as the
370
+ # individual CreateTaskRequest.parent .
371
+ # The maximum number of requests is 100.
372
+ # @!attribute [rw] request_id
373
+ # @return [::String]
374
+ # Optional. This field will be used to identify the long running operation,
375
+ # avoiding duplication when user retries. If not provided, then a UUID will
376
+ # be generated at server side.
377
+ class BatchCreateTasksRequest
378
+ include ::Google::Protobuf::MessageExts
379
+ extend ::Google::Protobuf::MessageExts::ClassMethods
380
+ end
381
+
357
382
  # Request message for deleting a task using
358
383
  # {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#delete_task DeleteTask}.
359
384
  # @!attribute [rw] name
@@ -365,6 +390,90 @@ module Google
365
390
  extend ::Google::Protobuf::MessageExts::ClassMethods
366
391
  end
367
392
 
393
+ # Request message for deleting a batch of tasks using
394
+ # {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#batch_delete_tasks BatchDeleteTasks}.
395
+ # @!attribute [rw] parent
396
+ # @return [::String]
397
+ # Required. The queue name. For example:
398
+ # Format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
399
+ # @!attribute [rw] names
400
+ # @return [::Array<::String>]
401
+ # Required. The names of the tasks to delete.
402
+ # A maximum of 1000 tasks can be deleted in a batch.
403
+ # For example:
404
+ # Format:
405
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
406
+ # @!attribute [rw] request_id
407
+ # @return [::String]
408
+ # Optional. This field will be used to identify the long running operation,
409
+ # avoiding duplication when user retries. If not provided, then a UUID will
410
+ # be generated at server side.
411
+ class BatchDeleteTasksRequest
412
+ include ::Google::Protobuf::MessageExts
413
+ extend ::Google::Protobuf::MessageExts::ClassMethods
414
+ end
415
+
416
+ # Metadata for the long-running operation returned by
417
+ # {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#batch_delete_tasks BatchDeleteTasks}.
418
+ # This message is used to hold metadata information about the
419
+ # batch delete tasks operation; that is, it is put in
420
+ # {::Google::Longrunning::Operation#metadata google.longrunning.Operation.metadata}.
421
+ # @!attribute [r] start_time
422
+ # @return [::Google::Protobuf::Timestamp]
423
+ # Output only. The time when the batch delete started.
424
+ # @!attribute [r] end_time
425
+ # @return [::Google::Protobuf::Timestamp]
426
+ # Output only. The time when the batch delete finished.
427
+ # @!attribute [r] state
428
+ # @return [::Google::Cloud::Tasks::V2beta3::BatchDeleteTasksMetadata::State]
429
+ # Output only. The state of the batch delete operation.
430
+ # @!attribute [r] failed_requests
431
+ # @return [::Google::Protobuf::Map{::Integer => ::Google::Rpc::Status}]
432
+ # Output only. A map of failed requests, where the key is the index of the
433
+ # request in BatchDeleteTasksRequest.names and the value is the error status.
434
+ class BatchDeleteTasksMetadata
435
+ include ::Google::Protobuf::MessageExts
436
+ extend ::Google::Protobuf::MessageExts::ClassMethods
437
+
438
+ # @!attribute [rw] key
439
+ # @return [::Integer]
440
+ # @!attribute [rw] value
441
+ # @return [::Google::Rpc::Status]
442
+ class FailedRequestsEntry
443
+ include ::Google::Protobuf::MessageExts
444
+ extend ::Google::Protobuf::MessageExts::ClassMethods
445
+ end
446
+
447
+ # The state of the batch delete operation.
448
+ # This enum is not frozen and new values may be added in the future.
449
+ module State
450
+ # The default value. This value is used if the state is omitted.
451
+ STATE_UNSPECIFIED = 0
452
+
453
+ # The batch delete is running.
454
+ RUNNING = 1
455
+
456
+ # The batch delete has finished and all tasks were successfully deleted.
457
+ SUCCEEDED = 2
458
+
459
+ # The batch delete has finished with partial success.
460
+ # The tasks that failed to be deleted are reported in
461
+ # {::Google::Cloud::Tasks::V2beta3::BatchDeleteTasksMetadata#failed_requests failed_requests}.
462
+ # When all requests in the batch fail,
463
+ # {::Google::Longrunning::Operation#error google.longrunning.Operation.error}
464
+ # will be set with `code` = `google.rpc.Code.ABORTED` and `message` = "None
465
+ # of the requests succeeded, refer to
466
+ # BatchDeleteTasksMetadata.failed_requests for individual error details".
467
+ PARTIALLY_SUCCEEDED = 3
468
+
469
+ # The batch delete has failed.
470
+ # This means the overall batch delete operation failed to complete.
471
+ # This can happen due to an internal error preventing the operation from
472
+ # finishing.
473
+ FAILED = 4
474
+ end
475
+ end
476
+
368
477
  # Request message for forcing a task to run now using
369
478
  # {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#run_task RunTask}.
370
479
  # @!attribute [rw] name
@@ -390,6 +499,94 @@ module Google
390
499
  include ::Google::Protobuf::MessageExts
391
500
  extend ::Google::Protobuf::MessageExts::ClassMethods
392
501
  end
502
+
503
+ # Response message for [BatchCreateTasks].
504
+ # @!attribute [rw] tasks
505
+ # @return [::Array<::Google::Cloud::Tasks::V2beta3::Task>]
506
+ # The tasks that were successfully created.
507
+ class BatchCreateTasksResponse
508
+ include ::Google::Protobuf::MessageExts
509
+ extend ::Google::Protobuf::MessageExts::ClassMethods
510
+ end
511
+
512
+ # Metadata message for [BatchCreateTasks].
513
+ # @!attribute [rw] start_time
514
+ # @return [::Google::Protobuf::Timestamp]
515
+ # The time when the batch create started.
516
+ # @!attribute [rw] end_time
517
+ # @return [::Google::Protobuf::Timestamp]
518
+ # The time when the batch create finished.
519
+ # @!attribute [r] state
520
+ # @return [::Google::Cloud::Tasks::V2beta3::BatchCreateTasksMetadata::State]
521
+ # Output only. The state of the batch create operation.
522
+ # @!attribute [rw] failed_requests
523
+ # @return [::Google::Protobuf::Map{::Integer => ::Google::Rpc::Status}]
524
+ # A map of failed requests, where the key is the index of the request in
525
+ # BatchCreateTasksRequest.requests and the value is the error status.
526
+ class BatchCreateTasksMetadata
527
+ include ::Google::Protobuf::MessageExts
528
+ extend ::Google::Protobuf::MessageExts::ClassMethods
529
+
530
+ # @!attribute [rw] key
531
+ # @return [::Integer]
532
+ # @!attribute [rw] value
533
+ # @return [::Google::Rpc::Status]
534
+ class FailedRequestsEntry
535
+ include ::Google::Protobuf::MessageExts
536
+ extend ::Google::Protobuf::MessageExts::ClassMethods
537
+ end
538
+
539
+ # The state of the batch create operation.
540
+ module State
541
+ # The default value. This value is used if the state is omitted.
542
+ STATE_UNSPECIFIED = 0
543
+
544
+ # The batch create is running.
545
+ RUNNING = 1
546
+
547
+ # The batch create has finished.
548
+ # All tasks in the request were successfully created.
549
+ SUCCEEDED = 2
550
+
551
+ # The batch create has finished with partial success.
552
+ # The tasks that failed to be created are reported in
553
+ # {::Google::Cloud::Tasks::V2beta3::BatchCreateTasksMetadata#failed_requests failed_requests}.
554
+ PARTIALLY_SUCCEEDED = 5
555
+
556
+ # The batch create has failed.
557
+ # This means the overall batch create operation failed to complete.
558
+ # This can happen due to an internal error preventing the operation from
559
+ # finishing.
560
+ FAILED = 3
561
+
562
+ # The batch create was cancelled.
563
+ CANCELLED = 4
564
+ end
565
+ end
566
+
567
+ # Request message for
568
+ # {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#update_cmek_config UpdateCmekConfig}.
569
+ # @!attribute [rw] cmek_config
570
+ # @return [::Google::Cloud::Tasks::V2beta3::CmekConfig]
571
+ # Required. The config to update. Its name attribute distinguishes it.
572
+ # @!attribute [rw] update_mask
573
+ # @return [::Google::Protobuf::FieldMask]
574
+ # List of fields to be updated in this request.
575
+ class UpdateCmekConfigRequest
576
+ include ::Google::Protobuf::MessageExts
577
+ extend ::Google::Protobuf::MessageExts::ClassMethods
578
+ end
579
+
580
+ # Request message for
581
+ # {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#get_cmek_config GetCmekConfig}.
582
+ # @!attribute [rw] name
583
+ # @return [::String]
584
+ # Required. The config resource name. For example:
585
+ # projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`
586
+ class GetCmekConfigRequest
587
+ include ::Google::Protobuf::MessageExts
588
+ extend ::Google::Protobuf::MessageExts::ClassMethods
589
+ end
393
590
  end
394
591
  end
395
592
  end
@@ -0,0 +1,44 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2026 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module Tasks
23
+ module V2beta3
24
+ # Describes the customer-managed encryption key (CMEK) configuration associated
25
+ # with a project and location.
26
+ # @!attribute [r] name
27
+ # @return [::String]
28
+ # Output only. The config resource name which includes the project and
29
+ # location and must end in 'cmekConfig', in the format
30
+ # projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`
31
+ # @!attribute [rw] kms_key
32
+ # @return [::String]
33
+ # Resource name of the Cloud KMS key, of the form
34
+ # `projects/PROJECT_ID/locations/LOCATION_ID/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID`,
35
+ # that will be used to encrypt the Queues & Tasks in the region. Setting
36
+ # this as blank will turn off CMEK encryption.
37
+ class CmekConfig
38
+ include ::Google::Protobuf::MessageExts
39
+ extend ::Google::Protobuf::MessageExts::ClassMethods
40
+ end
41
+ end
42
+ end
43
+ end
44
+ end
@@ -71,8 +71,8 @@ module Google
71
71
  # queue, regardless of whether the dispatch is from a first
72
72
  # attempt or a retry).
73
73
  # * {::Google::Cloud::Tasks::V2beta3::Queue#retry_config retry_config} controls
74
- # what happens to
75
- # particular a task after its first attempt fails. That is,
74
+ # what happens to a
75
+ # particular task after its first attempt fails. That is,
76
76
  # {::Google::Cloud::Tasks::V2beta3::Queue#retry_config retry_config} controls
77
77
  # task retries (the second attempt, third attempt, etc).
78
78
  #
@@ -126,17 +126,23 @@ module Google
126
126
  # @!attribute [rw] task_ttl
127
127
  # @return [::Google::Protobuf::Duration]
128
128
  # The maximum amount of time that a task will be retained in
129
- # this queue.
129
+ # this queue. After a task has lived for `task_ttl`, the task will be deleted
130
+ # regardless of whether it was dispatched or not.
131
+ #
132
+ # The minimum value is 10 days. The maximum value is 10 years. The value
133
+ # must be given as a string that indicates the length of time (in seconds)
134
+ # followed by `s` (for "seconds"). For more information on the format, see
135
+ # the documentation for
136
+ # [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration).
130
137
  #
131
138
  # Queues created by Cloud Tasks have a default `task_ttl` of 31 days.
132
- # After a task has lived for `task_ttl`, the task will be deleted
133
- # regardless of whether it was dispatched or not.
139
+ # .
134
140
  #
135
- # The `task_ttl` for queues created via queue.yaml/xml is equal to the
136
- # maximum duration because there is a
137
- # [storage quota](https://cloud.google.com/appengine/quotas#Task_Queue) for
138
- # these queues. To view the maximum valid duration, see the documentation for
139
- # {::Google::Protobuf::Duration Duration}.
141
+ # Queues created by queue.yaml/xml have a fixed `task_ttl` of the maximum
142
+ # duration, because there is a
143
+ # [storage
144
+ # quota](https://docs.cloud.google.com/appengine/docs/standard/quotas#Task_Queue)
145
+ # for these queues.
140
146
  # @!attribute [rw] tombstone_ttl
141
147
  # @return [::Google::Protobuf::Duration]
142
148
  # The task tombstone time to live (TTL).
@@ -148,6 +154,12 @@ module Google
148
154
  # about task de-duplication, see the documentation for
149
155
  # {::Google::Cloud::Tasks::V2beta3::CreateTaskRequest#task CreateTaskRequest}.
150
156
  #
157
+ # The minimum value is 1 hour. The maximum value is 9 days. The value
158
+ # must be given as a string that indicates the length of time (in seconds)
159
+ # followed by `s` (for "seconds"). For more information on the format, see
160
+ # the documentation for
161
+ # [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration).
162
+ #
151
163
  # Queues created by Cloud Tasks have a default `tombstone_ttl` of 1 hour.
152
164
  # @!attribute [rw] stackdriver_logging_config
153
165
  # @return [::Google::Cloud::Tasks::V2beta3::StackdriverLoggingConfig]
@@ -236,9 +248,8 @@ module Google
236
248
  # If unspecified when the queue is created, Cloud Tasks will pick the
237
249
  # default.
238
250
  #
239
- # * For {::Google::Cloud::Tasks::V2beta3::AppEngineHttpQueue App Engine queues},
240
- # the maximum allowed value
241
- # is 500.
251
+ # For {::Google::Cloud::Tasks::V2beta3::AppEngineHttpQueue App Engine queues}, the
252
+ # maximum allowed value is 500.
242
253
  #
243
254
  #
244
255
  # This field has the same meaning as
@@ -306,17 +317,25 @@ module Google
306
317
  # These settings determine when a failed task attempt is retried.
307
318
  # @!attribute [rw] max_attempts
308
319
  # @return [::Integer]
309
- # Number of attempts per task.
320
+ # Number of attempts per task, including the first attempt. (If the
321
+ # first attempt fails, there will be `max_attempts - 1` retries.)
310
322
  #
311
- # Cloud Tasks will attempt the task `max_attempts` times (that is, if the
312
- # first attempt fails, then there will be `max_attempts - 1` retries). Must
313
- # be >= -1.
323
+ # Must be greater than or equal to -1, which indicates unlimited attempts.
324
+ #
325
+ #
326
+ # Cloud Tasks stops retrying only when `max_attempts` and
327
+ # `max_retry_duration` are both satisfied, or when the task is successfully
328
+ # executed. When the task has been attempted
329
+ # `max_attempts` times and when the `max_retry_duration` time has passed, no
330
+ # further attempts are made, and the task is deleted. If `max_attempts` is
331
+ # set to -1 and `max_retry_duration` is set to 0, the task is retried
332
+ # until the [maximum task
333
+ # retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit is
334
+ # reached.
314
335
  #
315
336
  # If unspecified when the queue is created, Cloud Tasks will pick the
316
337
  # default.
317
338
  #
318
- # -1 indicates unlimited attempts.
319
- #
320
339
  # This field has the same meaning as
321
340
  # [task_retry_limit in
322
341
  # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
@@ -327,16 +346,22 @@ module Google
327
346
  # attempted. Once `max_retry_duration` time has passed *and* the
328
347
  # task has been attempted
329
348
  # {::Google::Cloud::Tasks::V2beta3::RetryConfig#max_attempts max_attempts} times,
330
- # no further attempts will be made and the task will be deleted.
349
+ # no further attempts are made and the task is deleted.
331
350
  #
332
- # If zero, then the task age is unlimited.
333
- #
334
- # If unspecified when the queue is created, Cloud Tasks will pick the
335
- # default.
351
+ # A zero (0) indicates an unlimited duration, up to the
352
+ # [maximum task
353
+ # retention](https://docs.cloud.google.com/tasks/docs/quotas#limits) limit.
336
354
  #
337
355
  #
356
+ # The value must be given as a string that indicates the length of time
357
+ # (in seconds) followed by `s` (for "seconds"). For the maximum possible
358
+ # value or the format, see the documentation for
359
+ # [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration).
338
360
  # `max_retry_duration` will be truncated to the nearest second.
339
361
  #
362
+ # If unspecified when the queue is created, Cloud Tasks will pick the
363
+ # default.
364
+ #
340
365
  # This field has the same meaning as
341
366
  # [task_age_limit in
342
367
  # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
@@ -350,12 +375,16 @@ module Google
350
375
  # {::Google::Cloud::Tasks::V2beta3::RetryConfig RetryConfig} specifies that the
351
376
  # task should be retried.
352
377
  #
353
- # If unspecified when the queue is created, Cloud Tasks will pick the
354
- # default.
355
- #
356
378
  #
379
+ # The value must be given as a string that indicates the length of time
380
+ # (in seconds) followed by `s` (for "seconds"). For more information on the
381
+ # format, see the documentation for
382
+ # [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration).
357
383
  # `min_backoff` will be truncated to the nearest second.
358
384
  #
385
+ # If unspecified when the queue is created, Cloud Tasks will pick the
386
+ # default.
387
+ #
359
388
  # This field has the same meaning as
360
389
  # [min_backoff_seconds in
361
390
  # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
@@ -369,12 +398,16 @@ module Google
369
398
  # {::Google::Cloud::Tasks::V2beta3::RetryConfig RetryConfig} specifies that the
370
399
  # task should be retried.
371
400
  #
372
- # If unspecified when the queue is created, Cloud Tasks will pick the
373
- # default.
374
- #
375
401
  #
402
+ # The value must be given as a string that indicates the length of time
403
+ # (in seconds) followed by `s` (for "seconds"). For more information on the
404
+ # format, see the documentation for
405
+ # [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration).
376
406
  # `max_backoff` will be truncated to the nearest second.
377
407
  #
408
+ # If unspecified when the queue is created, Cloud Tasks will pick the
409
+ # default.
410
+ #
378
411
  # This field has the same meaning as
379
412
  # [max_backoff_seconds in
380
413
  # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
@@ -27,9 +27,9 @@ module Google
27
27
  # {::Google::Cloud::Tasks::V2beta3::Queue#type PULL} type. It currently exists for
28
28
  # backwards compatibility with the App Engine Task Queue SDK. This message type
29
29
  # maybe returned with methods
30
- # [list][google.cloud.tasks.v2beta3.CloudTask.ListTasks] and
31
- # [get][google.cloud.tasks.v2beta3.CloudTask.ListTasks], when the response view
32
- # is [FULL][google.cloud.tasks.v2beta3.Task.View.Full].
30
+ # {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#list_tasks list} and
31
+ # {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#list_tasks get}, when the response
32
+ # view is {::Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL}.
33
33
  # @!attribute [rw] payload
34
34
  # @return [::String]
35
35
  # A data payload consumed by the worker to execute the task.
@@ -95,9 +95,10 @@ module Google
95
95
  # Port override.
96
96
  #
97
97
  # When specified, replaces the port part of the task URI. For instance,
98
- # for a URI http://www.google.com/foo and port=123, the overridden URI
99
- # becomes http://www.google.com:123/foo. Note that the port value must be a
100
- # positive integer. Setting the port to 0 (Zero) clears the URI port.
98
+ # for a URI "https://www.example.com/example" and port=123, the overridden
99
+ # URI becomes "https://www.example.com:123/example". Note that the port value
100
+ # must be a positive integer. Setting the port to 0 (Zero) clears the URI
101
+ # port.
101
102
  # @!attribute [rw] path_override
102
103
  # @return [::Google::Cloud::Tasks::V2beta3::PathOverride]
103
104
  # URI path.
@@ -125,12 +126,12 @@ module Google
125
126
  # Scheme unspecified. Defaults to HTTPS.
126
127
  SCHEME_UNSPECIFIED = 0
127
128
 
128
- # Convert the scheme to HTTP, e.g., https://www.google.ca will change to
129
- # http://www.google.ca.
129
+ # Convert the scheme to HTTP, e.g., "https://www.example.com" will change
130
+ # to "http://www.example.com".
130
131
  HTTP = 1
131
132
 
132
- # Convert the scheme to HTTPS, e.g., http://www.google.ca will change to
133
- # https://www.google.ca.
133
+ # Convert the scheme to HTTPS, e.g., "http://www.example.com" will change
134
+ # to "https://www.example.com".
134
135
  HTTPS = 2
135
136
  end
136
137
 
@@ -152,8 +153,8 @@ module Google
152
153
 
153
154
  # HTTP target.
154
155
  #
155
- # When specified as a [Queue][target_type], all the tasks with [HttpRequest]
156
- # will be overridden according to the target.
156
+ # When specified as a {::Google::Cloud::Tasks::V2beta3::Queue Queue}, all the tasks
157
+ # with [HttpRequest] will be overridden according to the target.
157
158
  # @!attribute [rw] uri_override
158
159
  # @return [::Google::Cloud::Tasks::V2beta3::UriOverride]
159
160
  # URI override.
@@ -164,9 +165,11 @@ module Google
164
165
  # The HTTP method to use for the request.
165
166
  #
166
167
  # When specified, it overrides
167
- # {::Google::Cloud::Tasks::V2beta3::HttpTarget#http_method HttpRequest} for the
168
- # task. Note that if the value is set to [HttpMethod][GET] the
169
- # [HttpRequest][body] of the task will be ignored at execution time.
168
+ # {::Google::Cloud::Tasks::V2beta3::HttpRequest#http_method HttpRequest.http_method}
169
+ # for the task. Note that if the value is set to
170
+ # {::Google::Cloud::Tasks::V2beta3::HttpMethod::GET HttpMethod.GET} the
171
+ # {::Google::Cloud::Tasks::V2beta3::HttpRequest#body HttpRequest.body} of the task
172
+ # will be ignored at execution time.
170
173
  # @!attribute [rw] header_overrides
171
174
  # @return [::Array<::Google::Cloud::Tasks::V2beta3::HttpTarget::HeaderOverride>]
172
175
  # HTTP target headers.
@@ -200,27 +203,35 @@ module Google
200
203
  #
201
204
  # The size of the headers must be less than 80KB.
202
205
  # Queue-level headers to override headers of all the tasks in the queue.
206
+ #
207
+ # Do not put business sensitive or personally identifying data in the HTTP
208
+ # Header Override Configuration or other similar fields in accordance with
209
+ # Section 12 (Resource Fields) of the
210
+ # [Service Specific Terms](https://cloud.google.com/terms/service-terms).
203
211
  # @!attribute [rw] oauth_token
204
212
  # @return [::Google::Cloud::Tasks::V2beta3::OAuthToken]
205
213
  # If specified, an
206
214
  # [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
207
- # will be generated and attached as the `Authorization` header in the HTTP
215
+ # is generated and attached as the `Authorization` header in the HTTP
208
216
  # request.
209
217
  #
210
- # This type of authorization should generally only be used when calling
211
- # Google APIs hosted on *.googleapis.com.
218
+ # This type of authorization should generally be used only when calling
219
+ # Google APIs hosted on *.googleapis.com. Note that both the service
220
+ # account email and the scope MUST be specified when using the queue-level
221
+ # authorization override.
212
222
  #
213
223
  # Note: The following fields are mutually exclusive: `oauth_token`, `oidc_token`. If a field in that set is populated, all other fields in the set will automatically be cleared.
214
224
  # @!attribute [rw] oidc_token
215
225
  # @return [::Google::Cloud::Tasks::V2beta3::OidcToken]
216
226
  # If specified, an
217
227
  # [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)
218
- # token will be generated and attached as an `Authorization` header in the
228
+ # token is generated and attached as an `Authorization` header in the
219
229
  # HTTP request.
220
230
  #
221
231
  # This type of authorization can be used for many scenarios, including
222
232
  # calling Cloud Run, or endpoints where you intend to validate the token
223
- # yourself.
233
+ # yourself. Note that both the service account email and the audience MUST
234
+ # be specified when using the queue-level authorization override.
224
235
  #
225
236
  # Note: The following fields are mutually exclusive: `oidc_token`, `oauth_token`. If a field in that set is populated, all other fields in the set will automatically be cleared.
226
237
  class HttpTarget
@@ -242,7 +253,12 @@ module Google
242
253
  # Wraps the Header object.
243
254
  # @!attribute [rw] header
244
255
  # @return [::Google::Cloud::Tasks::V2beta3::HttpTarget::Header]
245
- # header embodying a key and a value.
256
+ # Header embodying a key and a value.
257
+ #
258
+ # Do not put business sensitive or personally identifying data in the HTTP
259
+ # Header Override Configuration or other similar fields in accordance with
260
+ # Section 12 (Resource Fields) of the
261
+ # [Service Specific Terms](https://cloud.google.com/terms/service-terms).
246
262
  class HeaderOverride
247
263
  include ::Google::Protobuf::MessageExts
248
264
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -309,7 +325,7 @@ module Google
309
325
  #
310
326
  # * Any header that is prefixed with "X-CloudTasks-" will be treated
311
327
  # as service header. Service headers define properties of the task and are
312
- # predefined in CloudTask.
328
+ # predefined in Cloud Tasks.
313
329
  # * Host: This will be computed by Cloud Tasks and derived from
314
330
  # {::Google::Cloud::Tasks::V2beta3::HttpRequest#url HttpRequest.url}.
315
331
  # * Content-Length: This will be computed by Cloud Tasks.
@@ -119,6 +119,10 @@ module Google
119
119
  # information see
120
120
  # [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts).
121
121
  #
122
+ # The value must be given as a string that indicates the length of time
123
+ # (in seconds) followed by `s` (for "seconds"). For more information on the
124
+ # format, see the documentation for
125
+ # [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration).
122
126
  # `dispatch_deadline` will be truncated to the nearest millisecond. The
123
127
  # deadline is an approximate deadline.
124
128
  # @!attribute [rw] dispatch_count
@@ -144,6 +148,11 @@ module Google
144
148
  # @return [::Google::Cloud::Tasks::V2beta3::Task::View]
145
149
  # Output only. The view specifies which subset of the
146
150
  # {::Google::Cloud::Tasks::V2beta3::Task Task} has been returned.
151
+ # @!attribute [rw] retry_config
152
+ # @return [::Google::Cloud::Tasks::V2beta3::RetryConfig]
153
+ # Optional. Specifies the task-level retry config.
154
+ #
155
+ # If present, this overrides the queue-level retry config for this task.
147
156
  class Task
148
157
  include ::Google::Protobuf::MessageExts
149
158
  extend ::Google::Protobuf::MessageExts::ClassMethods