Skip to content

Commit d23680f

Browse files
feat: update gapic-common dependency to 1.3 and document retry jitter (#33329)
feat: add locations field to AutomatedBackupPolicy docs: A comment for field `retention_period` in message `.google.bigtable.admin.v2.Table` is changed docs: A comment for field `frequency` in message `.google.bigtable.admin.v2.Table` is changed PiperOrigin-RevId: 888234464 Source-Link: googleapis/googleapis@5993bc6 Source-Link: googleapis/googleapis-gen@773a76b Copy-Tag: eyJwIjoiZ29vZ2xlLWNsb3VkLWJpZ3RhYmxlLWFkbWluLXYyLy5Pd2xCb3QueWFtbCIsImgiOiI3NzNhNzZiMjMzYTBhMmI4YmExNjUxMjk1Nzk0NDFjZWRiNjhmMTU3In0= * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * feat: publish client batch config schema feat: publish new error reasons docs: fix documentation formatting docs: update various comments docs: update license year PiperOrigin-RevId: 889289393 Source-Link: googleapis/googleapis@94bc991 Source-Link: googleapis/googleapis-gen@db7143a Copy-Tag: eyJwIjoiZ29vZ2xlLWNsb3VkLWJpZ3RhYmxlLWFkbWluLXYyLy5Pd2xCb3QueWFtbCIsImgiOiJkYjcxNDNhMzM4YTdjNzU4MzliNDY5OGNiM2VhNmYxMDEzYjRjM2M3In0= * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * docs: update SelectiveGapicGeneration usage doc PiperOrigin-RevId: 892649773 Source-Link: googleapis/googleapis@06a20b2 Source-Link: googleapis/googleapis-gen@d9ae664 Copy-Tag: eyJwIjoiZ29vZ2xlLWNsb3VkLWJpZ3RhYmxlLWFkbWluLXYyLy5Pd2xCb3QueWFtbCIsImgiOiJkOWFlNjY0NTFmODFjOWRmOTlkYmRjOWIyM2JkNzVkMDA3MzgwZjRlIn0= * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * feat: add Editions field to Instance PiperOrigin-RevId: 900156940 Source-Link: googleapis/googleapis@9761131 Source-Link: googleapis/googleapis-gen@658fe51 Copy-Tag: eyJwIjoiZ29vZ2xlLWNsb3VkLWJpZ3RhYmxlLWFkbWluLXYyLy5Pd2xCb3QueWFtbCIsImgiOiI2NThmZTUxM2Q3NDE2NmYwZDkyZDE4YTM3N2ZlZTk1Y2I5Y2JmZGY2In0= * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * feat: update gapic-common dependency to 1.3 and document retry jitter docs: list Ruby 3.2+ as supported versions in README fix: rename client variable in tests PiperOrigin-RevId: 930120621 Source-Link: googleapis/googleapis@f7b1717 Source-Link: googleapis/googleapis-gen@e38df62 Copy-Tag: eyJwIjoiZ29vZ2xlLWNsb3VkLWJpZ3RhYmxlLWFkbWluLXYyLy5Pd2xCb3QueWFtbCIsImgiOiJlMzhkZjYyODVkOTE5OGZlNjkxZTZkOGI1M2U3NmZiNTFjZGRmNWNjIn0= * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent c85917c commit d23680f

17 files changed

Lines changed: 691 additions & 494 deletions

File tree

google-cloud-bigtable-admin-v2/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ To browse ready to use code samples check [Google Cloud Samples](https://cloud.g
8686

8787
## Supported Ruby Versions
8888

89-
This library is supported on Ruby 3.0+.
89+
This library is supported on Ruby 3.2+.
9090

9191
Google provides official support for Ruby versions that are actively supported
9292
by Ruby Core—that is, Ruby versions that are either in normal maintenance or

google-cloud-bigtable-admin-v2/google-cloud-bigtable-admin-v2.gemspec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Gem::Specification.new do |gem|
2323

2424
gem.required_ruby_version = ">= 3.2"
2525

26-
gem.add_dependency "gapic-common", "~> 1.2"
26+
gem.add_dependency "gapic-common", "~> 1.3"
2727
gem.add_dependency "google-cloud-errors", "~> 1.0"
2828
gem.add_dependency "grpc-google-iam-v1", "~> 1.11"
2929
end

google-cloud-bigtable-admin-v2/lib/google/bigtable/admin/v2/instance_pb.rb

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

google-cloud-bigtable-admin-v2/lib/google/bigtable/admin/v2/table_pb.rb

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

google-cloud-bigtable-admin-v2/lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin/client.rb

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -581,7 +581,7 @@ def list_instances request, options = nil
581581
# @param options [::Gapic::CallOptions, ::Hash]
582582
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
583583
#
584-
# @overload update_instance(name: nil, display_name: nil, type: nil, labels: nil, tags: nil)
584+
# @overload update_instance(name: nil, display_name: nil, type: nil, edition: nil, labels: nil, tags: nil)
585585
# Pass arguments to `update_instance` via keyword arguments. Note that at
586586
# least one keyword argument is required. To specify no parameters, or to keep all
587587
# the default parameter values, pass an empty Hash as a request object (see above).
@@ -595,6 +595,9 @@ def list_instances request, options = nil
595595
# to avoid confusion.
596596
# @param type [::Google::Cloud::Bigtable::Admin::V2::Instance::Type]
597597
# The type of the instance. Defaults to `PRODUCTION`.
598+
# @param edition [::Google::Cloud::Bigtable::Admin::V2::Instance::Edition]
599+
# Optional. The edition of the instance. See
600+
# {::Google::Cloud::Bigtable::Admin::V2::Instance::Edition Edition} for details.
598601
# @param labels [::Hash{::String => ::String}]
599602
# Labels are a flexible and lightweight mechanism for organizing cloud
600603
# resources into groups that reflect a customer's organizational needs and
@@ -3389,6 +3392,7 @@ def delete_materialized_view request, options = nil
33893392
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
33903393
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
33913394
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
3395+
# * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
33923396
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
33933397
# trigger a retry.
33943398
# @return [::Hash]
@@ -3472,6 +3476,7 @@ def channel_pool
34723476
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
34733477
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
34743478
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
3479+
# * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
34753480
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
34763481
# trigger a retry.
34773482
#

google-cloud-bigtable-admin-v2/lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin/operations.rb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -704,6 +704,7 @@ def wait_operation request, options = nil
704704
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
705705
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
706706
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
707+
# * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
707708
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
708709
# trigger a retry.
709710
# @return [::Hash]
@@ -787,6 +788,7 @@ def channel_pool
787788
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
788789
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
789790
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
791+
# * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
790792
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
791793
# trigger a retry.
792794
#

google-cloud-bigtable-admin-v2/lib/google/cloud/bigtable/admin/v2/bigtable_table_admin/client.rb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3917,6 +3917,7 @@ def delete_schema_bundle request, options = nil
39173917
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
39183918
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
39193919
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
3920+
# * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
39203921
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
39213922
# trigger a retry.
39223923
# @return [::Hash]
@@ -4000,6 +4001,7 @@ def channel_pool
40004001
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
40014002
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
40024003
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
4004+
# * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
40034005
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
40044006
# trigger a retry.
40054007
#

google-cloud-bigtable-admin-v2/lib/google/cloud/bigtable/admin/v2/bigtable_table_admin/operations.rb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -704,6 +704,7 @@ def wait_operation request, options = nil
704704
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
705705
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
706706
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
707+
# * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
707708
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
708709
# trigger a retry.
709710
# @return [::Hash]
@@ -787,6 +788,7 @@ def channel_pool
787788
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
788789
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
789790
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
791+
# * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
790792
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
791793
# trigger a retry.
792794
#

google-cloud-bigtable-admin-v2/lib/google/cloud/bigtable/admin/v2/bigtable_table_admin/paths.rb

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,23 @@ def instance_path project:, instance:
126126
"projects/#{project}/instances/#{instance}"
127127
end
128128

129+
##
130+
# Create a fully-qualified Location resource string.
131+
#
132+
# The resource will be in the following format:
133+
#
134+
# `projects/{project}/locations/{location}`
135+
#
136+
# @param project [String]
137+
# @param location [String]
138+
#
139+
# @return [::String]
140+
def location_path project:, location:
141+
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
142+
143+
"projects/#{project}/locations/#{location}"
144+
end
145+
129146
##
130147
# Create a fully-qualified SchemaBundle resource string.
131148
#

google-cloud-bigtable-admin-v2/proto_docs/google/api/client.rb

Lines changed: 149 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ module Api
3131
# @!attribute [rw] selective_gapic_generation
3232
# @return [::Google::Api::SelectiveGapicGeneration]
3333
# Configuration for which RPCs should be generated in the GAPIC client.
34+
#
35+
# Note: This field should not be used in most cases.
3436
class CommonLanguageSettings
3537
include ::Google::Protobuf::MessageExts
3638
extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -141,9 +143,10 @@ class Publishing
141143
#
142144
# Example of a YAML configuration::
143145
#
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
147150
# @!attribute [rw] service_class_names
148151
# @return [::Google::Protobuf::Map{::String => ::String}]
149152
# Configure the Java class name to use instead of the service's for its
@@ -155,11 +158,11 @@ class Publishing
155158
#
156159
# Example of a YAML configuration::
157160
#
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
163166
# @!attribute [rw] common
164167
# @return [::Google::Api::CommonLanguageSettings]
165168
# Some settings.
@@ -190,6 +193,20 @@ class CppSettings
190193
# @!attribute [rw] common
191194
# @return [::Google::Api::CommonLanguageSettings]
192195
# 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
193210
class PhpSettings
194211
include ::Google::Protobuf::MessageExts
195212
extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -318,10 +335,12 @@ class RubySettings
318335
# service names and values are the name to be used for the service client
319336
# and call options.
320337
#
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
325344
class GoSettings
326345
include ::Google::Protobuf::MessageExts
327346
extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -344,10 +363,10 @@ class RenamedServicesEntry
344363
#
345364
# Example:
346365
#
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...
351370
# @!attribute [rw] long_running
352371
# @return [::Google::Api::MethodSettings::LongRunning]
353372
# Describes settings to use for long-running operations when generating
@@ -356,14 +375,14 @@ class RenamedServicesEntry
356375
#
357376
# Example of a YAML configuration::
358377
#
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
367386
# @!attribute [rw] auto_populated_fields
368387
# @return [::Array<::String>]
369388
# List of top-level fields of the request message, that should be
@@ -372,11 +391,24 @@ class RenamedServicesEntry
372391
#
373392
# Example of a YAML configuration:
374393
#
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
380412
class MethodSettings
381413
include ::Google::Protobuf::MessageExts
382414
extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -411,6 +443,8 @@ class LongRunning
411443

412444
# This message is used to configure the generation of a subset of the RPCs in
413445
# a service for client libraries.
446+
#
447+
# Note: This feature should not be used in most cases.
414448
# @!attribute [rw] methods
415449
# @return [::Array<::String>]
416450
# An allowlist of the fully qualified names of RPCs that should be included
@@ -428,6 +462,77 @@ class SelectiveGapicGeneration
428462
extend ::Google::Protobuf::MessageExts::ClassMethods
429463
end
430464

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+
431536
# The organization for which the client libraries are being published.
432537
# Affects the url where generated docs are published, etc.
433538
module ClientLibraryOrganization
@@ -469,5 +574,20 @@ module ClientLibraryDestination
469574
# Publish the library to package managers like nuget.org and npmjs.com.
470575
PACKAGE_MANAGER = 20
471576
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
472592
end
473593
end

0 commit comments

Comments
 (0)