google-cloud-bigtable-v2 0.3.5 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c90c50444567ff4682d49633255ca1d40c05171d436b68fe53dce1a5be39fb2
-  data.tar.gz: ddc37a4b38bef15f7edd20a9298058b58d046c146090f2608cde9d7466217470
+  metadata.gz: e3d0a762196c965a95b62e358f682a2c49486cee28f3d857e449d229c530a4c9
+  data.tar.gz: 124d897a14d9176041a7d8932fc91c18236f883ed330f3c9513a80f4f178d196
 SHA512:
-  metadata.gz: '08db2e86395447945430a3285bda40bb62de085207e97e9ed3de7debd83143b2fd5985d4d7e27c91211633b17660e00c59a6ed17fca277980abd30b97aa3c395'
-  data.tar.gz: 5abf0be8fe9ee217b2668c6d06b1c8ff9d30258cd0a8c39aa3580f9c4faa8fce682994638cdd6797dc37c2c177d2552f087907d1f4f663a63860acd46dd6818b
+  metadata.gz: 73c368aa55886ecbb17eee966d89a7bff00928050231a2d78f6e9fdd306883f49919084eeedbf8c359f553516b40b7b7e3faa9c6f623f45ea6f1ee7e81a48c3d
+  data.tar.gz: 14c33cbb66b68371afdb2099398234408782d5ac8c3916e4767776db3ebf5a268edb4d5279ee77610dad1072f320848c6b9aacabe33ff898c48945fa3cac0bb8

data/README.md

@@ -37,7 +37,7 @@ request = ::Google::Cloud::Bigtable::V2::ReadRowsRequest.new # (request fields a
 response = client.read_rows request
 ```
 
-View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-bigtable-v2/latest)
+View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-bigtable-v2/latest)
 for class and method documentation.
 
 See also the [Product Documentation](https://cloud.google.com/bigtable)
@@ -69,16 +69,21 @@ module GRPC
 end
 ```
 
+
+## Google Cloud Samples
+
+To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
+
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.5+.
+This library is supported on Ruby 2.6+.
 
 Google provides official support for Ruby versions that are actively supported
 by Ruby Core—that is, Ruby versions that are either in normal maintenance or
-in security maintenance, and not end of life. Currently, this means Ruby 2.5
-and later. Older versions of Ruby _may_ still work, but are unsupported and not
-recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
-about the Ruby support schedule.
+in security maintenance, and not end of life. Older versions of Ruby _may_
+still work, but are unsupported and not recommended. See
+https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby
+support schedule.
 
 ## Which client should I use?
 

data/lib/google/bigtable/v2/bigtable_pb.rb

@@ -1,14 +1,16 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/bigtable/v2/bigtable.proto
 
+require 'google/protobuf'
+
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
+require 'google/api/routing_pb'
 require 'google/bigtable/v2/data_pb'
 require 'google/protobuf/wrappers_pb'
 require 'google/rpc/status_pb'
-require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/bigtable/v2/bigtable.proto", :syntax => :proto3) do
@@ -79,6 +81,12 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     add_message "google.bigtable.v2.CheckAndMutateRowResponse" do
       optional :predicate_matched, :bool, 1
     end
+    add_message "google.bigtable.v2.PingAndWarmRequest" do
+      optional :name, :string, 1
+      optional :app_profile_id, :string, 2
+    end
+    add_message "google.bigtable.v2.PingAndWarmResponse" do
+    end
     add_message "google.bigtable.v2.ReadModifyWriteRowRequest" do
       optional :table_name, :string, 1
       optional :app_profile_id, :string, 4
@@ -108,6 +116,8 @@ module Google
         MutateRowsResponse::Entry = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.MutateRowsResponse.Entry").msgclass
         CheckAndMutateRowRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.CheckAndMutateRowRequest").msgclass
         CheckAndMutateRowResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.CheckAndMutateRowResponse").msgclass
+        PingAndWarmRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.PingAndWarmRequest").msgclass
+        PingAndWarmResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.PingAndWarmResponse").msgclass
         ReadModifyWriteRowRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.ReadModifyWriteRowRequest").msgclass
         ReadModifyWriteRowResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.ReadModifyWriteRowResponse").msgclass
       end

data/lib/google/bigtable/v2/bigtable_services_pb.rb

@@ -1,7 +1,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # Source: google/bigtable/v2/bigtable.proto for package 'Google.Cloud.Bigtable.V2'
 # Original file comments:
-# Copyright 2019 Google LLC.
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -53,6 +53,9 @@ module Google
             rpc :MutateRows, ::Google::Cloud::Bigtable::V2::MutateRowsRequest, stream(::Google::Cloud::Bigtable::V2::MutateRowsResponse)
             # Mutates a row atomically based on the output of a predicate Reader filter.
             rpc :CheckAndMutateRow, ::Google::Cloud::Bigtable::V2::CheckAndMutateRowRequest, ::Google::Cloud::Bigtable::V2::CheckAndMutateRowResponse
+            # Warm up associated instance metadata for this connection.
+            # This call is not required but may be useful for connection keep-alive.
+            rpc :PingAndWarm, ::Google::Cloud::Bigtable::V2::PingAndWarmRequest, ::Google::Cloud::Bigtable::V2::PingAndWarmResponse
             # Modifies a row atomically on the server. The method reads the latest
             # existing timestamp and value from the specified columns and writes a new
             # entry based on pre-defined read/modify/write rules. The new value for the

data/lib/google/cloud/bigtable/v2/bigtable/client.rb

@@ -65,14 +65,8 @@ module Google
                 default_config = Client::Configuration.new parent_config
 
                 default_config.rpcs.read_rows.timeout = 43_200.0
-                default_config.rpcs.read_rows.retry_policy = {
-                  initial_delay: 0.01, max_delay: 60.0, multiplier: 2, retry_codes: []
-                }
 
                 default_config.rpcs.sample_row_keys.timeout = 60.0
-                default_config.rpcs.sample_row_keys.retry_policy = {
-                  initial_delay: 0.01, max_delay: 60.0, multiplier: 2, retry_codes: []
-                }
 
                 default_config.rpcs.mutate_row.timeout = 60.0
                 default_config.rpcs.mutate_row.retry_policy = {
@@ -80,19 +74,10 @@ module Google
                 }
 
                 default_config.rpcs.mutate_rows.timeout = 600.0
-                default_config.rpcs.mutate_rows.retry_policy = {
-                  initial_delay: 0.01, max_delay: 60.0, multiplier: 2, retry_codes: []
-                }
 
                 default_config.rpcs.check_and_mutate_row.timeout = 20.0
-                default_config.rpcs.check_and_mutate_row.retry_policy = {
-                  initial_delay: 0.01, max_delay: 60.0, multiplier: 2, retry_codes: []
-                }
 
                 default_config.rpcs.read_modify_write_row.timeout = 20.0
-                default_config.rpcs.read_modify_write_row.retry_policy = {
-                  initial_delay: 0.01, max_delay: 60.0, multiplier: 2, retry_codes: []
-                }
 
                 default_config
               end
@@ -204,12 +189,13 @@ module Google
             #     This value specifies routing for replication. If not specified, the
             #     "default" application profile will be used.
             #   @param rows [::Google::Cloud::Bigtable::V2::RowSet, ::Hash]
-            #     The row keys and/or ranges to read. If not specified, reads from all rows.
+            #     The row keys and/or ranges to read sequentially. If not specified, reads
+            #     from all rows.
             #   @param filter [::Google::Cloud::Bigtable::V2::RowFilter, ::Hash]
             #     The filter to apply to the contents of the specified row(s). If unset,
             #     reads the entirety of each row.
             #   @param rows_limit [::Integer]
-            #     The read will terminate after committing to N rows' worth of results. The
+            #     The read will stop after committing to N rows' worth of results. The
             #     default (zero) is to return all results.
             #
             # @yield [response, operation] Access the result along with the RPC operation
@@ -256,11 +242,15 @@ module Google
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
               header_params = {}
-              if request.table_name
+              if request.table_name &&
+                 %r{^projects/[^/]+/instances/[^/]+/tables/[^/]+/?$}.match?(request.table_name)
                 header_params["table_name"] = request.table_name
               end
+              if request.app_profile_id && !request.app_profile_id.empty?
+                header_params["app_profile_id"] = request.app_profile_id
+              end
 
-              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              request_params_header = URI.encode_www_form header_params
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.read_rows.timeout,
@@ -352,11 +342,15 @@ module Google
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
               header_params = {}
-              if request.table_name
+              if request.table_name &&
+                 %r{^projects/[^/]+/instances/[^/]+/tables/[^/]+/?$}.match?(request.table_name)
                 header_params["table_name"] = request.table_name
               end
+              if request.app_profile_id && !request.app_profile_id.empty?
+                header_params["app_profile_id"] = request.app_profile_id
+              end
 
-              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              request_params_header = URI.encode_www_form header_params
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.sample_row_keys.timeout,
@@ -449,11 +443,15 @@ module Google
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
               header_params = {}
-              if request.table_name
+              if request.table_name &&
+                 %r{^projects/[^/]+/instances/[^/]+/tables/[^/]+/?$}.match?(request.table_name)
                 header_params["table_name"] = request.table_name
               end
+              if request.app_profile_id && !request.app_profile_id.empty?
+                header_params["app_profile_id"] = request.app_profile_id
+              end
 
-              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              request_params_header = URI.encode_www_form header_params
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.mutate_row.timeout,
@@ -548,11 +546,15 @@ module Google
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
               header_params = {}
-              if request.table_name
+              if request.table_name &&
+                 %r{^projects/[^/]+/instances/[^/]+/tables/[^/]+/?$}.match?(request.table_name)
                 header_params["table_name"] = request.table_name
               end
+              if request.app_profile_id && !request.app_profile_id.empty?
+                header_params["app_profile_id"] = request.app_profile_id
+              end
 
-              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              request_params_header = URI.encode_www_form header_params
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.mutate_rows.timeout,
@@ -658,11 +660,15 @@ module Google
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
               header_params = {}
-              if request.table_name
+              if request.table_name &&
+                 %r{^projects/[^/]+/instances/[^/]+/tables/[^/]+/?$}.match?(request.table_name)
                 header_params["table_name"] = request.table_name
               end
+              if request.app_profile_id && !request.app_profile_id.empty?
+                header_params["app_profile_id"] = request.app_profile_id
+              end
 
-              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              request_params_header = URI.encode_www_form header_params
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.check_and_mutate_row.timeout,
@@ -681,6 +687,100 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Warm up associated instance metadata for this connection.
+            # This call is not required but may be useful for connection keep-alive.
+            #
+            # @overload ping_and_warm(request, options = nil)
+            #   Pass arguments to `ping_and_warm` via a request object, either of type
+            #   {::Google::Cloud::Bigtable::V2::PingAndWarmRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::Bigtable::V2::PingAndWarmRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload ping_and_warm(name: nil, app_profile_id: nil)
+            #   Pass arguments to `ping_and_warm` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param name [::String]
+            #     Required. The unique name of the instance to check permissions for as well as
+            #     respond. Values are of the form `projects/<project>/instances/<instance>`.
+            #   @param app_profile_id [::String]
+            #     This value specifies routing for replication. If not specified, the
+            #     "default" application profile will be used.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Cloud::Bigtable::V2::PingAndWarmResponse]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Cloud::Bigtable::V2::PingAndWarmResponse]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/cloud/bigtable/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Bigtable::V2::Bigtable::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Bigtable::V2::PingAndWarmRequest.new
+            #
+            #   # Call the ping_and_warm method.
+            #   result = client.ping_and_warm request
+            #
+            #   # The returned object is of type Google::Cloud::Bigtable::V2::PingAndWarmResponse.
+            #   p result
+            #
+            def ping_and_warm request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigtable::V2::PingAndWarmRequest
+
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+              # Customize the options with defaults
+              metadata = @config.rpcs.ping_and_warm.metadata.to_h
+
+              # Set x-goog-api-client and x-goog-user-project headers
+              metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                lib_name: @config.lib_name, lib_version: @config.lib_version,
+                gapic_version: ::Google::Cloud::Bigtable::V2::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {}
+              if request.name &&
+                 %r{^projects/[^/]+/instances/[^/]+/?$}.match?(request.name)
+                header_params["name"] = request.name
+              end
+              if request.app_profile_id && !request.app_profile_id.empty?
+                header_params["app_profile_id"] = request.app_profile_id
+              end
+
+              request_params_header = URI.encode_www_form header_params
+              metadata[:"x-goog-request-params"] ||= request_params_header
+
+              options.apply_defaults timeout:      @config.rpcs.ping_and_warm.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.ping_and_warm.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @bigtable_stub.call_rpc :ping_and_warm, request, options: options do |response, operation|
+                yield response, operation if block_given?
+                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Modifies a row atomically on the server. The method reads the latest
             # existing timestamp and value from the specified columns and writes a new
@@ -759,11 +859,15 @@ module Google
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
               header_params = {}
-              if request.table_name
+              if request.table_name &&
+                 %r{^projects/[^/]+/instances/[^/]+/tables/[^/]+/?$}.match?(request.table_name)
                 header_params["table_name"] = request.table_name
               end
+              if request.app_profile_id && !request.app_profile_id.empty?
+                header_params["app_profile_id"] = request.app_profile_id
+              end
 
-              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              request_params_header = URI.encode_www_form header_params
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.read_modify_write_row.timeout,
@@ -943,6 +1047,11 @@ module Google
                 #
                 attr_reader :check_and_mutate_row
                 ##
+                # RPC-specific configuration for `ping_and_warm`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :ping_and_warm
+                ##
                 # RPC-specific configuration for `read_modify_write_row`
                 # @return [::Gapic::Config::Method]
                 #
@@ -960,6 +1069,8 @@ module Google
                   @mutate_rows = ::Gapic::Config::Method.new mutate_rows_config
                   check_and_mutate_row_config = parent_rpcs.check_and_mutate_row if parent_rpcs.respond_to? :check_and_mutate_row
                   @check_and_mutate_row = ::Gapic::Config::Method.new check_and_mutate_row_config
+                  ping_and_warm_config = parent_rpcs.ping_and_warm if parent_rpcs.respond_to? :ping_and_warm
+                  @ping_and_warm = ::Gapic::Config::Method.new ping_and_warm_config
                   read_modify_write_row_config = parent_rpcs.read_modify_write_row if parent_rpcs.respond_to? :read_modify_write_row
                   @read_modify_write_row = ::Gapic::Config::Method.new read_modify_write_row_config
 

data/lib/google/cloud/bigtable/v2/bigtable/paths.rb

@@ -24,6 +24,23 @@ module Google
         module Bigtable
           # Path helper methods for the Bigtable API.
           module Paths
+            ##
+            # Create a fully-qualified Instance resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/instances/{instance}`
+            #
+            # @param project [String]
+            # @param instance [String]
+            #
+            # @return [::String]
+            def instance_path project:, instance:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+
+              "projects/#{project}/instances/#{instance}"
+            end
+
             ##
             # Create a fully-qualified Table resource string.
             #

data/lib/google/cloud/bigtable/v2/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Bigtable
       module V2
-        VERSION = "0.3.5"
+        VERSION = "0.6.0"
       end
     end
   end

data/lib/google/cloud/bigtable/v2.rb

@@ -25,6 +25,8 @@ module Google
       ##
       # To load this package, including all its services, and instantiate a client:
       #
+      # @example
+      #
       #     require "google/cloud/bigtable/v2"
       #     client = ::Google::Cloud::Bigtable::V2::Bigtable::Client.new
       #

data/proto_docs/google/api/routing.rb

@@ -0,0 +1,459 @@
+# frozen_string_literal: true
+
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Api
+    # Specifies the routing information that should be sent along with the request
+    # in the form of routing header.
+    # **NOTE:** All service configuration rules follow the "last one wins" order.
+    #
+    # The examples below will apply to an RPC which has the following request type:
+    #
+    # Message Definition:
+    #
+    #     message Request {
+    #       // The name of the Table
+    #       // Values can be of the following formats:
+    #       // - `projects/<project>/tables/<table>`
+    #       // - `projects/<project>/instances/<instance>/tables/<table>`
+    #       // - `region/<region>/zones/<zone>/tables/<table>`
+    #       string table_name = 1;
+    #
+    #       // This value specifies routing for replication.
+    #       // It can be in the following formats:
+    #       // - `profiles/<profile_id>`
+    #       // - a legacy `profile_id` that can be any string
+    #       string app_profile_id = 2;
+    #     }
+    #
+    # Example message:
+    #
+    #     {
+    #       table_name: projects/proj_foo/instances/instance_bar/table/table_baz,
+    #       app_profile_id: profiles/prof_qux
+    #     }
+    #
+    # The routing header consists of one or multiple key-value pairs. Every key
+    # and value must be percent-encoded, and joined together in the format of
+    # `key1=value1&key2=value2`.
+    # In the examples below I am skipping the percent-encoding for readablity.
+    #
+    # Example 1
+    #
+    # Extracting a field from the request to put into the routing header
+    # unchanged, with the key equal to the field name.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // Take the `app_profile_id`.
+    #       routing_parameters {
+    #         field: "app_profile_id"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params: app_profile_id=profiles/prof_qux
+    #
+    # Example 2
+    #
+    # Extracting a field from the request to put into the routing header
+    # unchanged, with the key different from the field name.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // Take the `app_profile_id`, but name it `routing_id` in the header.
+    #       routing_parameters {
+    #         field: "app_profile_id"
+    #         path_template: "{routing_id=**}"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params: routing_id=profiles/prof_qux
+    #
+    # Example 3
+    #
+    # Extracting a field from the request to put into the routing
+    # header, while matching a path template syntax on the field's value.
+    #
+    # NB: it is more useful to send nothing than to send garbage for the purpose
+    # of dynamic routing, since garbage pollutes cache. Thus the matching.
+    #
+    # Sub-example 3a
+    #
+    # The field matches the template.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // Take the `table_name`, if it's well-formed (with project-based
+    #       // syntax).
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{table_name=projects/*/instances/*/**}"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params:
+    #     table_name=projects/proj_foo/instances/instance_bar/table/table_baz
+    #
+    # Sub-example 3b
+    #
+    # The field does not match the template.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // Take the `table_name`, if it's well-formed (with region-based
+    #       // syntax).
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{table_name=regions/*/zones/*/**}"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     <no routing header will be sent>
+    #
+    # Sub-example 3c
+    #
+    # Multiple alternative conflictingly named path templates are
+    # specified. The one that matches is used to construct the header.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // Take the `table_name`, if it's well-formed, whether
+    #       // using the region- or projects-based syntax.
+    #
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{table_name=regions/*/zones/*/**}"
+    #       }
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{table_name=projects/*/instances/*/**}"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params:
+    #     table_name=projects/proj_foo/instances/instance_bar/table/table_baz
+    #
+    # Example 4
+    #
+    # Extracting a single routing header key-value pair by matching a
+    # template syntax on (a part of) a single request field.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // Take just the project id from the `table_name` field.
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{routing_id=projects/*}/**"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params: routing_id=projects/proj_foo
+    #
+    # Example 5
+    #
+    # Extracting a single routing header key-value pair by matching
+    # several conflictingly named path templates on (parts of) a single request
+    # field. The last template to match "wins" the conflict.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // If the `table_name` does not have instances information,
+    #       // take just the project id for routing.
+    #       // Otherwise take project + instance.
+    #
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{routing_id=projects/*}/**"
+    #       }
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{routing_id=projects/*/instances/*}/**"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params:
+    #     routing_id=projects/proj_foo/instances/instance_bar
+    #
+    # Example 6
+    #
+    # Extracting multiple routing header key-value pairs by matching
+    # several non-conflicting path templates on (parts of) a single request field.
+    #
+    # Sub-example 6a
+    #
+    # Make the templates strict, so that if the `table_name` does not
+    # have an instance information, nothing is sent.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // The routing code needs two keys instead of one composite
+    #       // but works only for the tables with the "project-instance" name
+    #       // syntax.
+    #
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{project_id=projects/*}/instances/*/**"
+    #       }
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "projects/*/{instance_id=instances/*}/**"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params:
+    #     project_id=projects/proj_foo&instance_id=instances/instance_bar
+    #
+    # Sub-example 6b
+    #
+    # Make the templates loose, so that if the `table_name` does not
+    # have an instance information, just the project id part is sent.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // The routing code wants two keys instead of one composite
+    #       // but will work with just the `project_id` for tables without
+    #       // an instance in the `table_name`.
+    #
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{project_id=projects/*}/**"
+    #       }
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "projects/*/{instance_id=instances/*}/**"
+    #       }
+    #     };
+    #
+    # result (is the same as 6a for our example message because it has the instance
+    # information):
+    #
+    #     x-goog-request-params:
+    #     project_id=projects/proj_foo&instance_id=instances/instance_bar
+    #
+    # Example 7
+    #
+    # Extracting multiple routing header key-value pairs by matching
+    # several path templates on multiple request fields.
+    #
+    # NB: note that here there is no way to specify sending nothing if one of the
+    # fields does not match its template. E.g. if the `table_name` is in the wrong
+    # format, the `project_id` will not be sent, but the `routing_id` will be.
+    # The backend routing code has to be aware of that and be prepared to not
+    # receive a full complement of keys if it expects multiple.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // The routing needs both `project_id` and `routing_id`
+    #       // (from the `app_profile_id` field) for routing.
+    #
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{project_id=projects/*}/**"
+    #       }
+    #       routing_parameters {
+    #         field: "app_profile_id"
+    #         path_template: "{routing_id=**}"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params:
+    #     project_id=projects/proj_foo&routing_id=profiles/prof_qux
+    #
+    # Example 8
+    #
+    # Extracting a single routing header key-value pair by matching
+    # several conflictingly named path templates on several request fields. The
+    # last template to match "wins" the conflict.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // The `routing_id` can be a project id or a region id depending on
+    #       // the table name format, but only if the `app_profile_id` is not set.
+    #       // If `app_profile_id` is set it should be used instead.
+    #
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{routing_id=projects/*}/**"
+    #       }
+    #       routing_parameters {
+    #          field: "table_name"
+    #          path_template: "{routing_id=regions/*}/**"
+    #       }
+    #       routing_parameters {
+    #         field: "app_profile_id"
+    #         path_template: "{routing_id=**}"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params: routing_id=profiles/prof_qux
+    #
+    # Example 9
+    #
+    # Bringing it all together.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // For routing both `table_location` and a `routing_id` are needed.
+    #       //
+    #       // table_location can be either an instance id or a region+zone id.
+    #       //
+    #       // For `routing_id`, take the value of `app_profile_id`
+    #       // - If it's in the format `profiles/<profile_id>`, send
+    #       // just the `<profile_id>` part.
+    #       // - If it's any other literal, send it as is.
+    #       // If the `app_profile_id` is empty, and the `table_name` starts with
+    #       // the project_id, send that instead.
+    #
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "projects/*/{table_location=instances/*}/tables/*"
+    #       }
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{table_location=regions/*/zones/*}/tables/*"
+    #       }
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{routing_id=projects/*}/**"
+    #       }
+    #       routing_parameters {
+    #         field: "app_profile_id"
+    #         path_template: "{routing_id=**}"
+    #       }
+    #       routing_parameters {
+    #         field: "app_profile_id"
+    #         path_template: "profiles/{routing_id=*}"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params:
+    #     table_location=instances/instance_bar&routing_id=prof_qux
+    # @!attribute [rw] routing_parameters
+    #   @return [::Array<::Google::Api::RoutingParameter>]
+    #     A collection of Routing Parameter specifications.
+    #     **NOTE:** If multiple Routing Parameters describe the same key
+    #     (via the `path_template` field or via the `field` field when
+    #     `path_template` is not provided), "last one wins" rule
+    #     determines which Parameter gets used.
+    #     See the examples for more details.
+    class RoutingRule
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # A projection from an input message to the GRPC or REST header.
+    # @!attribute [rw] field
+    #   @return [::String]
+    #     A request field to extract the header key-value pair from.
+    # @!attribute [rw] path_template
+    #   @return [::String]
+    #     A pattern matching the key-value field. Optional.
+    #     If not specified, the whole field specified in the `field` field will be
+    #     taken as value, and its name used as key. If specified, it MUST contain
+    #     exactly one named segment (along with any number of unnamed segments) The
+    #     pattern will be matched over the field specified in the `field` field, then
+    #     if the match is successful:
+    #     - the name of the single named segment will be used as a header name,
+    #     - the match value of the segment will be used as a header value;
+    #     if the match is NOT successful, nothing will be sent.
+    #
+    #     Example:
+    #
+    #                   -- This is a field in the request message
+    #                  |   that the header value will be extracted from.
+    #                  |
+    #                  |                     -- This is the key name in the
+    #                  |                    |   routing header.
+    #                  V                    |
+    #         field: "table_name"           v
+    #         path_template: "projects/*/{table_location=instances/*}/tables/*"
+    #                                                    ^            ^
+    #                                                    |            |
+    #           In the {} brackets is the pattern that --             |
+    #           specifies what to extract from the                    |
+    #           field as a value to be sent.                          |
+    #                                                                 |
+    #          The string in the field must match the whole pattern --
+    #          before brackets, inside brackets, after brackets.
+    #
+    #     When looking at this specific example, we can see that:
+    #     - A key-value pair with the key `table_location`
+    #       and the value matching `instances/*` should be added
+    #       to the x-goog-request-params routing header.
+    #     - The value is extracted from the request message's `table_name` field
+    #       if it matches the full pattern specified:
+    #       `projects/*/instances/*/tables/*`.
+    #
+    #     **NB:** If the `path_template` field is not provided, the key name is
+    #     equal to the field name, and the whole field should be sent as a value.
+    #     This makes the pattern for the field and the value functionally equivalent
+    #     to `**`, and the configuration
+    #
+    #         {
+    #           field: "table_name"
+    #         }
+    #
+    #     is a functionally equivalent shorthand to:
+    #
+    #         {
+    #           field: "table_name"
+    #           path_template: "{table_name=**}"
+    #         }
+    #
+    #     See Example 1 for more details.
+    class RoutingParameter
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/bigtable/v2/bigtable.rb

@@ -33,14 +33,15 @@ module Google
         #     "default" application profile will be used.
         # @!attribute [rw] rows
         #   @return [::Google::Cloud::Bigtable::V2::RowSet]
-        #     The row keys and/or ranges to read. If not specified, reads from all rows.
+        #     The row keys and/or ranges to read sequentially. If not specified, reads
+        #     from all rows.
         # @!attribute [rw] filter
         #   @return [::Google::Cloud::Bigtable::V2::RowFilter]
         #     The filter to apply to the contents of the specified row(s). If unset,
         #     reads the entirety of each row.
         # @!attribute [rw] rows_limit
         #   @return [::Integer]
-        #     The read will terminate after committing to N rows' worth of results. The
+        #     The read will stop after committing to N rows' worth of results. The
         #     default (zero) is to return all results.
         class ReadRowsRequest
           include ::Google::Protobuf::MessageExts
@@ -303,6 +304,26 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Request message for client connection keep-alive and warming.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The unique name of the instance to check permissions for as well as
+        #     respond. Values are of the form `projects/<project>/instances/<instance>`.
+        # @!attribute [rw] app_profile_id
+        #   @return [::String]
+        #     This value specifies routing for replication. If not specified, the
+        #     "default" application profile will be used.
+        class PingAndWarmRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for Bigtable.PingAndWarm connection keepalive and warming.
+        class PingAndWarmResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Request message for Bigtable.ReadModifyWriteRow.
         # @!attribute [rw] table_name
         #   @return [::String]

data/proto_docs/google/bigtable/v2/data.rb

@@ -209,7 +209,7 @@ module Google
         # RowFilter.Chain and RowFilter.Interleave documentation.
         #
         # The total serialized size of a RowFilter message must not
-        # exceed 4096 bytes, and RowFilters may not be nested within each other
+        # exceed 20480 bytes, and RowFilters may not be nested within each other
         # (in Chains or Interleaves) to a depth of more than 20.
         # @!attribute [rw] chain
         #   @return [::Google::Cloud::Bigtable::V2::RowFilter::Chain]

data/proto_docs/google/protobuf/any.rb

@@ -44,7 +44,7 @@ module Google
     #       foo = any.unpack(Foo.class);
     #     }
     #
-    #  Example 3: Pack and unpack a message in Python.
+    # Example 3: Pack and unpack a message in Python.
     #
     #     foo = Foo(...)
     #     any = Any()
@@ -54,7 +54,7 @@ module Google
     #       any.Unpack(foo)
     #       ...
     #
-    #  Example 4: Pack and unpack a message in Go
+    # Example 4: Pack and unpack a message in Go
     #
     #      foo := &pb.Foo{...}
     #      any, err := anypb.New(foo)
@@ -75,7 +75,7 @@ module Google
     #
     #
     # JSON
-    # ====
+    #
     # The JSON representation of an `Any` value uses the regular
     # representation of the deserialized, embedded message, with an
     # additional field `@type` which contains the type URL. Example:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-bigtable-v2
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.6.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-11 00:00:00.000000000 Z
+date: 2022-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.10'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.10'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -50,28 +50,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.25.1
+        version: 1.26.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.25.1
+        version: 1.26.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '5.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '5.16'
 - !ruby/object:Gem::Dependency
   name: minitest-focus
   requirement: !ruby/object:Gem::Requirement
@@ -106,14 +106,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -183,6 +183,7 @@ files:
 - proto_docs/README.md
 - proto_docs/google/api/field_behavior.rb
 - proto_docs/google/api/resource.rb
+- proto_docs/google/api/routing.rb
 - proto_docs/google/bigtable/v2/bigtable.rb
 - proto_docs/google/bigtable/v2/data.rb
 - proto_docs/google/protobuf/any.rb
@@ -200,14 +201,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.4
+rubygems_version: 3.3.14
 signing_key: 
 specification_version: 4
 summary: API Client library for the Cloud Bigtable V2 API