google-cloud-tasks-v2beta3 0.18.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.
@@ -31,6 +31,8 @@ module Google
31
31
  # @!attribute [rw] selective_gapic_generation
32
32
  # @return [::Google::Api::SelectiveGapicGeneration]
33
33
  # Configuration for which RPCs should be generated in the GAPIC client.
34
+ #
35
+ # Note: This field should not be used in most cases.
34
36
  class CommonLanguageSettings
35
37
  include ::Google::Protobuf::MessageExts
36
38
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -141,9 +143,10 @@ module Google
141
143
  #
142
144
  # Example of a YAML configuration::
143
145
  #
144
- # publishing:
145
- # java_settings:
146
- # library_package: com.google.cloud.pubsub.v1
146
+ # publishing:
147
+ # library_settings:
148
+ # java_settings:
149
+ # library_package: com.google.cloud.pubsub.v1
147
150
  # @!attribute [rw] service_class_names
148
151
  # @return [::Google::Protobuf::Map{::String => ::String}]
149
152
  # Configure the Java class name to use instead of the service's for its
@@ -155,11 +158,11 @@ module Google
155
158
  #
156
159
  # Example of a YAML configuration::
157
160
  #
158
- # publishing:
159
- # java_settings:
160
- # service_class_names:
161
- # - google.pubsub.v1.Publisher: TopicAdmin
162
- # - google.pubsub.v1.Subscriber: SubscriptionAdmin
161
+ # publishing:
162
+ # java_settings:
163
+ # service_class_names:
164
+ # - google.pubsub.v1.Publisher: TopicAdmin
165
+ # - google.pubsub.v1.Subscriber: SubscriptionAdmin
163
166
  # @!attribute [rw] common
164
167
  # @return [::Google::Api::CommonLanguageSettings]
165
168
  # Some settings.
@@ -190,6 +193,20 @@ module Google
190
193
  # @!attribute [rw] common
191
194
  # @return [::Google::Api::CommonLanguageSettings]
192
195
  # Some settings.
196
+ # @!attribute [rw] library_package
197
+ # @return [::String]
198
+ # The package name to use in Php. Clobbers the php_namespace option
199
+ # set in the protobuf. This should be used **only** by APIs
200
+ # who have already set the language_settings.php.package_name" field
201
+ # in gapic.yaml. API teams should use the protobuf php_namespace option
202
+ # where possible.
203
+ #
204
+ # Example of a YAML configuration::
205
+ #
206
+ # publishing:
207
+ # library_settings:
208
+ # php_settings:
209
+ # library_package: Google\Cloud\PubSub\V1
193
210
  class PhpSettings
194
211
  include ::Google::Protobuf::MessageExts
195
212
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -318,10 +335,12 @@ module Google
318
335
  # service names and values are the name to be used for the service client
319
336
  # and call options.
320
337
  #
321
- # publishing:
322
- # go_settings:
323
- # renamed_services:
324
- # Publisher: TopicAdmin
338
+ # Example:
339
+ #
340
+ # publishing:
341
+ # go_settings:
342
+ # renamed_services:
343
+ # Publisher: TopicAdmin
325
344
  class GoSettings
326
345
  include ::Google::Protobuf::MessageExts
327
346
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -344,10 +363,10 @@ module Google
344
363
  #
345
364
  # Example:
346
365
  #
347
- # publishing:
348
- # method_settings:
349
- # - selector: google.storage.control.v2.StorageControl.CreateFolder
350
- # # method settings for CreateFolder...
366
+ # publishing:
367
+ # method_settings:
368
+ # - selector: google.storage.control.v2.StorageControl.CreateFolder
369
+ # # method settings for CreateFolder...
351
370
  # @!attribute [rw] long_running
352
371
  # @return [::Google::Api::MethodSettings::LongRunning]
353
372
  # Describes settings to use for long-running operations when generating
@@ -356,14 +375,14 @@ module Google
356
375
  #
357
376
  # Example of a YAML configuration::
358
377
  #
359
- # publishing:
360
- # method_settings:
361
- # - selector: google.cloud.speech.v2.Speech.BatchRecognize
362
- # long_running:
363
- # initial_poll_delay: 60s # 1 minute
364
- # poll_delay_multiplier: 1.5
365
- # max_poll_delay: 360s # 6 minutes
366
- # total_poll_timeout: 54000s # 90 minutes
378
+ # publishing:
379
+ # method_settings:
380
+ # - selector: google.cloud.speech.v2.Speech.BatchRecognize
381
+ # long_running:
382
+ # initial_poll_delay: 60s # 1 minute
383
+ # poll_delay_multiplier: 1.5
384
+ # max_poll_delay: 360s # 6 minutes
385
+ # total_poll_timeout: 54000s # 90 minutes
367
386
  # @!attribute [rw] auto_populated_fields
368
387
  # @return [::Array<::String>]
369
388
  # List of top-level fields of the request message, that should be
@@ -372,11 +391,24 @@ module Google
372
391
  #
373
392
  # Example of a YAML configuration:
374
393
  #
375
- # publishing:
376
- # method_settings:
377
- # - selector: google.example.v1.ExampleService.CreateExample
378
- # auto_populated_fields:
379
- # - request_id
394
+ # publishing:
395
+ # method_settings:
396
+ # - selector: google.example.v1.ExampleService.CreateExample
397
+ # auto_populated_fields:
398
+ # - request_id
399
+ # @!attribute [rw] batching
400
+ # @return [::Google::Api::BatchingConfigProto]
401
+ # Batching configuration for an API method in client libraries.
402
+ #
403
+ # Example of a YAML configuration:
404
+ #
405
+ # publishing:
406
+ # method_settings:
407
+ # - selector: google.example.v1.ExampleService.BatchCreateExample
408
+ # batching:
409
+ # element_count_threshold: 1000
410
+ # request_byte_threshold: 100000000
411
+ # delay_threshold_millis: 10
380
412
  class MethodSettings
381
413
  include ::Google::Protobuf::MessageExts
382
414
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -411,6 +443,8 @@ module Google
411
443
 
412
444
  # This message is used to configure the generation of a subset of the RPCs in
413
445
  # a service for client libraries.
446
+ #
447
+ # Note: This feature should not be used in most cases.
414
448
  # @!attribute [rw] methods
415
449
  # @return [::Array<::String>]
416
450
  # An allowlist of the fully qualified names of RPCs that should be included
@@ -428,6 +462,77 @@ module Google
428
462
  extend ::Google::Protobuf::MessageExts::ClassMethods
429
463
  end
430
464
 
465
+ # `BatchingConfigProto` defines the batching configuration for an API method.
466
+ # @!attribute [rw] thresholds
467
+ # @return [::Google::Api::BatchingSettingsProto]
468
+ # The thresholds which trigger a batched request to be sent.
469
+ # @!attribute [rw] batch_descriptor
470
+ # @return [::Google::Api::BatchingDescriptorProto]
471
+ # The request and response fields used in batching.
472
+ class BatchingConfigProto
473
+ include ::Google::Protobuf::MessageExts
474
+ extend ::Google::Protobuf::MessageExts::ClassMethods
475
+ end
476
+
477
+ # `BatchingSettingsProto` specifies a set of batching thresholds, each of
478
+ # which acts as a trigger to send a batch of messages as a request. At least
479
+ # one threshold must be positive nonzero.
480
+ # @!attribute [rw] element_count_threshold
481
+ # @return [::Integer]
482
+ # The number of elements of a field collected into a batch which, if
483
+ # exceeded, causes the batch to be sent.
484
+ # @!attribute [rw] request_byte_threshold
485
+ # @return [::Integer]
486
+ # The aggregated size of the batched field which, if exceeded, causes the
487
+ # batch to be sent. This size is computed by aggregating the sizes of the
488
+ # request field to be batched, not of the entire request message.
489
+ # @!attribute [rw] delay_threshold
490
+ # @return [::Google::Protobuf::Duration]
491
+ # The duration after which a batch should be sent, starting from the addition
492
+ # of the first message to that batch.
493
+ # @!attribute [rw] element_count_limit
494
+ # @return [::Integer]
495
+ # The maximum number of elements collected in a batch that could be accepted
496
+ # by server.
497
+ # @!attribute [rw] request_byte_limit
498
+ # @return [::Integer]
499
+ # The maximum size of the request that could be accepted by server.
500
+ # @!attribute [rw] flow_control_element_limit
501
+ # @return [::Integer]
502
+ # The maximum number of elements allowed by flow control.
503
+ # @!attribute [rw] flow_control_byte_limit
504
+ # @return [::Integer]
505
+ # The maximum size of data allowed by flow control.
506
+ # @!attribute [rw] flow_control_limit_exceeded_behavior
507
+ # @return [::Google::Api::FlowControlLimitExceededBehaviorProto]
508
+ # The behavior to take when the flow control limit is exceeded.
509
+ class BatchingSettingsProto
510
+ include ::Google::Protobuf::MessageExts
511
+ extend ::Google::Protobuf::MessageExts::ClassMethods
512
+ end
513
+
514
+ # `BatchingDescriptorProto` specifies the fields of the request message to be
515
+ # used for batching, and, optionally, the fields of the response message to be
516
+ # used for demultiplexing.
517
+ # @!attribute [rw] batched_field
518
+ # @return [::String]
519
+ # The repeated field in the request message to be aggregated by batching.
520
+ # @!attribute [rw] discriminator_fields
521
+ # @return [::Array<::String>]
522
+ # A list of the fields in the request message. Two requests will be batched
523
+ # together only if the values of every field specified in
524
+ # `request_discriminator_fields` is equal between the two requests.
525
+ # @!attribute [rw] subresponse_field
526
+ # @return [::String]
527
+ # Optional. When present, indicates the field in the response message to be
528
+ # used to demultiplex the response into multiple response messages, in
529
+ # correspondence with the multiple request messages originally batched
530
+ # together.
531
+ class BatchingDescriptorProto
532
+ include ::Google::Protobuf::MessageExts
533
+ extend ::Google::Protobuf::MessageExts::ClassMethods
534
+ end
535
+
431
536
  # The organization for which the client libraries are being published.
432
537
  # Affects the url where generated docs are published, etc.
433
538
  module ClientLibraryOrganization
@@ -469,5 +574,20 @@ module Google
469
574
  # Publish the library to package managers like nuget.org and npmjs.com.
470
575
  PACKAGE_MANAGER = 20
471
576
  end
577
+
578
+ # The behavior to take when the flow control limit is exceeded.
579
+ module FlowControlLimitExceededBehaviorProto
580
+ # Default behavior, system-defined.
581
+ UNSET_BEHAVIOR = 0
582
+
583
+ # Stop operation, raise error.
584
+ THROW_EXCEPTION = 1
585
+
586
+ # Pause operation until limit clears.
587
+ BLOCK = 2
588
+
589
+ # Continue operation, disregard limit.
590
+ IGNORE = 3
591
+ end
472
592
  end
473
593
  end
@@ -0,0 +1,88 @@
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 Api
22
+ # Rich semantic information of an API field beyond basic typing.
23
+ # @!attribute [rw] format
24
+ # @return [::Google::Api::FieldInfo::Format]
25
+ # The standard format of a field value. This does not explicitly configure
26
+ # any API consumer, just documents the API's format for the field it is
27
+ # applied to.
28
+ # @!attribute [rw] referenced_types
29
+ # @return [::Array<::Google::Api::TypeReference>]
30
+ # The type(s) that the annotated, generic field may represent.
31
+ #
32
+ # Currently, this must only be used on fields of type `google.protobuf.Any`.
33
+ # Supporting other generic types may be considered in the future.
34
+ class FieldInfo
35
+ include ::Google::Protobuf::MessageExts
36
+ extend ::Google::Protobuf::MessageExts::ClassMethods
37
+
38
+ # The standard format of a field value. The supported formats are all backed
39
+ # by either an RFC defined by the IETF or a Google-defined AIP.
40
+ module Format
41
+ # Default, unspecified value.
42
+ FORMAT_UNSPECIFIED = 0
43
+
44
+ # Universally Unique Identifier, version 4, value as defined by
45
+ # https://datatracker.ietf.org/doc/html/rfc4122. The value may be
46
+ # normalized to entirely lowercase letters. For example, the value
47
+ # `F47AC10B-58CC-0372-8567-0E02B2C3D479` would be normalized to
48
+ # `f47ac10b-58cc-0372-8567-0e02b2c3d479`.
49
+ UUID4 = 1
50
+
51
+ # Internet Protocol v4 value as defined by [RFC
52
+ # 791](https://datatracker.ietf.org/doc/html/rfc791). The value may be
53
+ # condensed, with leading zeros in each octet stripped. For example,
54
+ # `001.022.233.040` would be condensed to `1.22.233.40`.
55
+ IPV4 = 2
56
+
57
+ # Internet Protocol v6 value as defined by [RFC
58
+ # 2460](https://datatracker.ietf.org/doc/html/rfc2460). The value may be
59
+ # normalized to entirely lowercase letters with zeros compressed, following
60
+ # [RFC 5952](https://datatracker.ietf.org/doc/html/rfc5952). For example,
61
+ # the value `2001:0DB8:0::0` would be normalized to `2001:db8::`.
62
+ IPV6 = 3
63
+
64
+ # An IP address in either v4 or v6 format as described by the individual
65
+ # values defined herein. See the comments on the IPV4 and IPV6 types for
66
+ # allowed normalizations of each.
67
+ IPV4_OR_IPV6 = 4
68
+ end
69
+ end
70
+
71
+ # A reference to a message type, for use in {::Google::Api::FieldInfo FieldInfo}.
72
+ # @!attribute [rw] type_name
73
+ # @return [::String]
74
+ # The name of the type that the annotated, generic field may represent.
75
+ # If the type is in the same protobuf package, the value can be the simple
76
+ # message name e.g., `"MyMessage"`. Otherwise, the value must be the
77
+ # fully-qualified message name e.g., `"google.library.v1.Book"`.
78
+ #
79
+ # If the type(s) are unknown to the service (e.g. the field accepts generic
80
+ # user input), use the wildcard `"*"` to denote this behavior.
81
+ #
82
+ # See [AIP-202](https://google.aip.dev/202#type-references) for more details.
83
+ class TypeReference
84
+ include ::Google::Protobuf::MessageExts
85
+ extend ::Google::Protobuf::MessageExts::ClassMethods
86
+ end
87
+ end
88
+ end
@@ -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