google-cloud-bigtable-v2 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b488a55ed1e225be5451adb18dfc8738445870547b085792e064e8174e6071b
-  data.tar.gz: 6b48ff8142c4ee5e7ed9180597c16a4800a663514ce8946c626ac9539c65a2a6
+  metadata.gz: 4cfc6e05ad85852561ba6aa5d53d5fe73c273f2e0dde7703f6c63802af275ff9
+  data.tar.gz: a5b32e4d889b81242c3622f883fb117e81d26a911064c6ebd64b6f03f0287c3c
 SHA512:
-  metadata.gz: 2522db32282c52ff18ed77baaa0e7612f4495b0adf964449703067494633f0a6df785931db8f3eddeb37ac7900bebf0de4c4fee80cdc3589630859b94f2c32f6
-  data.tar.gz: a30680ad0592b8e1dde4822ef8bafe539b5ba7d2c181fb6bc10df48dd7259cd33675da77a6c6a4dfbe0f32b13996ee840210e0cc21ea8be71e9c1417e13da2f8
+  metadata.gz: 73c03468e20fd6ea4e9306cf304018635bc55d1caf8e3e878be7298155a5d01bbefd7a0535012a89ee19cc1b896cb94bfd7c26892276d1bbb7d9b9fc01891432
+  data.tar.gz: 3c1710b480304d76b52a0e7552851f59ab0edc03dfa23c069bae7bf3a698292dc91dee244c69c26b52af25cd10933a99c3d958fb477b5a537fa2ed1001561ea0

data/README.md

@@ -46,7 +46,7 @@ for general usage information.
 ## Enabling Logging
 
 To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
-The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
+The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
 or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
 that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
 and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.

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

@@ -10,6 +10,8 @@ require 'google/api/resource_pb'
 require 'google/api/routing_pb'
 require 'google/bigtable/v2/data_pb'
 require 'google/bigtable/v2/request_stats_pb'
+require 'google/protobuf/duration_pb'
+require 'google/protobuf/timestamp_pb'
 require 'google/protobuf/wrappers_pb'
 require 'google/rpc/status_pb'
 
@@ -104,6 +106,65 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     add_message "google.bigtable.v2.ReadModifyWriteRowResponse" do
       optional :row, :message, 1, "google.bigtable.v2.Row"
     end
+    add_message "google.bigtable.v2.GenerateInitialChangeStreamPartitionsRequest" do
+      optional :table_name, :string, 1
+      optional :app_profile_id, :string, 2
+    end
+    add_message "google.bigtable.v2.GenerateInitialChangeStreamPartitionsResponse" do
+      optional :partition, :message, 1, "google.bigtable.v2.StreamPartition"
+    end
+    add_message "google.bigtable.v2.ReadChangeStreamRequest" do
+      optional :table_name, :string, 1
+      optional :app_profile_id, :string, 2
+      optional :partition, :message, 3, "google.bigtable.v2.StreamPartition"
+      optional :end_time, :message, 5, "google.protobuf.Timestamp"
+      optional :heartbeat_duration, :message, 7, "google.protobuf.Duration"
+      oneof :start_from do
+        optional :start_time, :message, 4, "google.protobuf.Timestamp"
+        optional :continuation_tokens, :message, 6, "google.bigtable.v2.StreamContinuationTokens"
+      end
+    end
+    add_message "google.bigtable.v2.ReadChangeStreamResponse" do
+      oneof :stream_record do
+        optional :data_change, :message, 1, "google.bigtable.v2.ReadChangeStreamResponse.DataChange"
+        optional :heartbeat, :message, 2, "google.bigtable.v2.ReadChangeStreamResponse.Heartbeat"
+        optional :close_stream, :message, 3, "google.bigtable.v2.ReadChangeStreamResponse.CloseStream"
+      end
+    end
+    add_message "google.bigtable.v2.ReadChangeStreamResponse.MutationChunk" do
+      optional :chunk_info, :message, 1, "google.bigtable.v2.ReadChangeStreamResponse.MutationChunk.ChunkInfo"
+      optional :mutation, :message, 2, "google.bigtable.v2.Mutation"
+    end
+    add_message "google.bigtable.v2.ReadChangeStreamResponse.MutationChunk.ChunkInfo" do
+      optional :chunked_value_size, :int32, 1
+      optional :chunked_value_offset, :int32, 2
+      optional :last_chunk, :bool, 3
+    end
+    add_message "google.bigtable.v2.ReadChangeStreamResponse.DataChange" do
+      optional :type, :enum, 1, "google.bigtable.v2.ReadChangeStreamResponse.DataChange.Type"
+      optional :source_cluster_id, :string, 2
+      optional :row_key, :bytes, 3
+      optional :commit_timestamp, :message, 4, "google.protobuf.Timestamp"
+      optional :tiebreaker, :int32, 5
+      repeated :chunks, :message, 6, "google.bigtable.v2.ReadChangeStreamResponse.MutationChunk"
+      optional :done, :bool, 8
+      optional :token, :string, 9
+      optional :estimated_low_watermark, :message, 10, "google.protobuf.Timestamp"
+    end
+    add_enum "google.bigtable.v2.ReadChangeStreamResponse.DataChange.Type" do
+      value :TYPE_UNSPECIFIED, 0
+      value :USER, 1
+      value :GARBAGE_COLLECTION, 2
+      value :CONTINUATION, 3
+    end
+    add_message "google.bigtable.v2.ReadChangeStreamResponse.Heartbeat" do
+      optional :continuation_token, :message, 1, "google.bigtable.v2.StreamContinuationToken"
+      optional :estimated_low_watermark, :message, 2, "google.protobuf.Timestamp"
+    end
+    add_message "google.bigtable.v2.ReadChangeStreamResponse.CloseStream" do
+      optional :status, :message, 1, "google.rpc.Status"
+      repeated :continuation_tokens, :message, 2, "google.bigtable.v2.StreamContinuationToken"
+    end
   end
 end
 
@@ -129,6 +190,16 @@ module Google
         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
+        GenerateInitialChangeStreamPartitionsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.GenerateInitialChangeStreamPartitionsRequest").msgclass
+        GenerateInitialChangeStreamPartitionsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.GenerateInitialChangeStreamPartitionsResponse").msgclass
+        ReadChangeStreamRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.ReadChangeStreamRequest").msgclass
+        ReadChangeStreamResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.ReadChangeStreamResponse").msgclass
+        ReadChangeStreamResponse::MutationChunk = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.ReadChangeStreamResponse.MutationChunk").msgclass
+        ReadChangeStreamResponse::MutationChunk::ChunkInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.ReadChangeStreamResponse.MutationChunk.ChunkInfo").msgclass
+        ReadChangeStreamResponse::DataChange = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.ReadChangeStreamResponse.DataChange").msgclass
+        ReadChangeStreamResponse::DataChange::Type = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.ReadChangeStreamResponse.DataChange.Type").enummodule
+        ReadChangeStreamResponse::Heartbeat = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.ReadChangeStreamResponse.Heartbeat").msgclass
+        ReadChangeStreamResponse::CloseStream = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.ReadChangeStreamResponse.CloseStream").msgclass
       end
     end
   end

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

@@ -62,6 +62,16 @@ module Google
             # timestamp is the greater of the existing timestamp or the current server
             # time. The method returns the new contents of all modified cells.
             rpc :ReadModifyWriteRow, ::Google::Cloud::Bigtable::V2::ReadModifyWriteRowRequest, ::Google::Cloud::Bigtable::V2::ReadModifyWriteRowResponse
+            # NOTE: This API is intended to be used by Apache Beam BigtableIO.
+            # Returns the current list of partitions that make up the table's
+            # change stream. The union of partitions will cover the entire keyspace.
+            # Partitions can be read with `ReadChangeStream`.
+            rpc :GenerateInitialChangeStreamPartitions, ::Google::Cloud::Bigtable::V2::GenerateInitialChangeStreamPartitionsRequest, stream(::Google::Cloud::Bigtable::V2::GenerateInitialChangeStreamPartitionsResponse)
+            # NOTE: This API is intended to be used by Apache Beam BigtableIO.
+            # Reads changes from a table's change stream. Changes will
+            # reflect both user-initiated mutations and mutations that are caused by
+            # garbage collection.
+            rpc :ReadChangeStream, ::Google::Cloud::Bigtable::V2::ReadChangeStreamRequest, stream(::Google::Cloud::Bigtable::V2::ReadChangeStreamResponse)
           end
 
           Stub = Service.rpc_stub_class

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

@@ -127,6 +127,16 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
         optional :increment_amount, :int64, 4
       end
     end
+    add_message "google.bigtable.v2.StreamPartition" do
+      optional :row_range, :message, 1, "google.bigtable.v2.RowRange"
+    end
+    add_message "google.bigtable.v2.StreamContinuationTokens" do
+      repeated :tokens, :message, 1, "google.bigtable.v2.StreamContinuationToken"
+    end
+    add_message "google.bigtable.v2.StreamContinuationToken" do
+      optional :partition, :message, 1, "google.bigtable.v2.StreamPartition"
+      optional :token, :string, 2
+    end
   end
 end
 
@@ -153,6 +163,9 @@ module Google
         Mutation::DeleteFromFamily = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.Mutation.DeleteFromFamily").msgclass
         Mutation::DeleteFromRow = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.Mutation.DeleteFromRow").msgclass
         ReadModifyWriteRule = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.ReadModifyWriteRule").msgclass
+        StreamPartition = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.StreamPartition").msgclass
+        StreamContinuationTokens = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.StreamContinuationTokens").msgclass
+        StreamContinuationToken = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.StreamContinuationToken").msgclass
       end
     end
   end

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

@@ -79,6 +79,10 @@ module Google
 
                 default_config.rpcs.read_modify_write_row.timeout = 20.0
 
+                default_config.rpcs.generate_initial_change_stream_partitions.timeout = 60.0
+
+                default_config.rpcs.read_change_stream.timeout = 43_200.0
+
                 default_config
               end
               yield @configure if block_given?
@@ -217,13 +221,13 @@ module Google
             #   # Create a request. To set request fields, pass in keyword arguments.
             #   request = Google::Cloud::Bigtable::V2::ReadRowsRequest.new
             #
-            #   # Call the read_rows method.
-            #   result = client.read_rows request
+            #   # Call the read_rows method to start streaming.
+            #   output = client.read_rows request
             #
-            #   # The returned object is a streamed enumerable yielding elements of
-            #   # type ::Google::Cloud::Bigtable::V2::ReadRowsResponse.
-            #   result.each do |response|
-            #     p response
+            #   # The returned object is a streamed enumerable yielding elements of type
+            #   # ::Google::Cloud::Bigtable::V2::ReadRowsResponse
+            #   output.each do |current_response|
+            #     p current_response
             #   end
             #
             def read_rows request, options = nil
@@ -317,13 +321,13 @@ module Google
             #   # Create a request. To set request fields, pass in keyword arguments.
             #   request = Google::Cloud::Bigtable::V2::SampleRowKeysRequest.new
             #
-            #   # Call the sample_row_keys method.
-            #   result = client.sample_row_keys request
+            #   # Call the sample_row_keys method to start streaming.
+            #   output = client.sample_row_keys request
             #
-            #   # The returned object is a streamed enumerable yielding elements of
-            #   # type ::Google::Cloud::Bigtable::V2::SampleRowKeysResponse.
-            #   result.each do |response|
-            #     p response
+            #   # The returned object is a streamed enumerable yielding elements of type
+            #   # ::Google::Cloud::Bigtable::V2::SampleRowKeysResponse
+            #   output.each do |current_response|
+            #     p current_response
             #   end
             #
             def sample_row_keys request, options = nil
@@ -391,8 +395,8 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param table_name [::String]
-            #     Required. The unique name of the table to which the mutation should be applied.
-            #     Values are of the form
+            #     Required. The unique name of the table to which the mutation should be
+            #     applied. Values are of the form
             #     `projects/<project>/instances/<instance>/tables/<table>`.
             #   @param app_profile_id [::String]
             #     This value specifies routing for replication. If not specified, the
@@ -400,9 +404,9 @@ module Google
             #   @param row_key [::String]
             #     Required. The key of the row to which the mutation should be applied.
             #   @param mutations [::Array<::Google::Cloud::Bigtable::V2::Mutation, ::Hash>]
-            #     Required. Changes to be atomically applied to the specified row. Entries are applied
-            #     in order, meaning that earlier mutations can be masked by later ones.
-            #     Must contain at least one entry and at most 100000.
+            #     Required. Changes to be atomically applied to the specified row. Entries
+            #     are applied in order, meaning that earlier mutations can be masked by later
+            #     ones. Must contain at least one entry and at most 100000.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::Bigtable::V2::MutateRowResponse]
@@ -493,7 +497,8 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param table_name [::String]
-            #     Required. The unique name of the table to which the mutations should be applied.
+            #     Required. The unique name of the table to which the mutations should be
+            #     applied.
             #   @param app_profile_id [::String]
             #     This value specifies routing for replication. If not specified, the
             #     "default" application profile will be used.
@@ -521,13 +526,13 @@ module Google
             #   # Create a request. To set request fields, pass in keyword arguments.
             #   request = Google::Cloud::Bigtable::V2::MutateRowsRequest.new
             #
-            #   # Call the mutate_rows method.
-            #   result = client.mutate_rows request
+            #   # Call the mutate_rows method to start streaming.
+            #   output = client.mutate_rows request
             #
-            #   # The returned object is a streamed enumerable yielding elements of
-            #   # type ::Google::Cloud::Bigtable::V2::MutateRowsResponse.
-            #   result.each do |response|
-            #     p response
+            #   # The returned object is a streamed enumerable yielding elements of type
+            #   # ::Google::Cloud::Bigtable::V2::MutateRowsResponse
+            #   output.each do |current_response|
+            #     p current_response
             #   end
             #
             def mutate_rows request, options = nil
@@ -594,15 +599,15 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param table_name [::String]
-            #     Required. The unique name of the table to which the conditional mutation should be
-            #     applied.
-            #     Values are of the form
+            #     Required. The unique name of the table to which the conditional mutation
+            #     should be applied. Values are of the form
             #     `projects/<project>/instances/<instance>/tables/<table>`.
             #   @param app_profile_id [::String]
             #     This value specifies routing for replication. If not specified, the
             #     "default" application profile will be used.
             #   @param row_key [::String]
-            #     Required. The key of the row to which the conditional mutation should be applied.
+            #     Required. The key of the row to which the conditional mutation should be
+            #     applied.
             #   @param predicate_filter [::Google::Cloud::Bigtable::V2::RowFilter, ::Hash]
             #     The filter to be applied to the contents of the specified row. Depending
             #     on whether or not any results are yielded, either `true_mutations` or
@@ -709,8 +714,9 @@ module Google
             #   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>`.
+            #     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.
@@ -806,19 +812,19 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param table_name [::String]
-            #     Required. The unique name of the table to which the read/modify/write rules should be
-            #     applied.
-            #     Values are of the form
+            #     Required. The unique name of the table to which the read/modify/write rules
+            #     should be applied. Values are of the form
             #     `projects/<project>/instances/<instance>/tables/<table>`.
             #   @param app_profile_id [::String]
             #     This value specifies routing for replication. If not specified, the
             #     "default" application profile will be used.
             #   @param row_key [::String]
-            #     Required. The key of the row to which the read/modify/write rules should be applied.
+            #     Required. The key of the row to which the read/modify/write rules should be
+            #     applied.
             #   @param rules [::Array<::Google::Cloud::Bigtable::V2::ReadModifyWriteRule, ::Hash>]
-            #     Required. Rules specifying how the specified row's contents are to be transformed
-            #     into writes. Entries are applied in order, meaning that earlier rules will
-            #     affect the results of later ones.
+            #     Required. Rules specifying how the specified row's contents are to be
+            #     transformed into writes. Entries are applied in order, meaning that earlier
+            #     rules will affect the results of later ones.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::Bigtable::V2::ReadModifyWriteRowResponse]
@@ -888,6 +894,227 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # NOTE: This API is intended to be used by Apache Beam BigtableIO.
+            # Returns the current list of partitions that make up the table's
+            # change stream. The union of partitions will cover the entire keyspace.
+            # Partitions can be read with `ReadChangeStream`.
+            #
+            # @overload generate_initial_change_stream_partitions(request, options = nil)
+            #   Pass arguments to `generate_initial_change_stream_partitions` via a request object, either of type
+            #   {::Google::Cloud::Bigtable::V2::GenerateInitialChangeStreamPartitionsRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::Bigtable::V2::GenerateInitialChangeStreamPartitionsRequest, ::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 generate_initial_change_stream_partitions(table_name: nil, app_profile_id: nil)
+            #   Pass arguments to `generate_initial_change_stream_partitions` 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 table_name [::String]
+            #     Required. The unique name of the table from which to get change stream
+            #     partitions. Values are of the form
+            #     `projects/<project>/instances/<instance>/tables/<table>`.
+            #     Change streaming must be enabled on the table.
+            #   @param app_profile_id [::String]
+            #     This value specifies routing for replication. If not specified, the
+            #     "default" application profile will be used.
+            #     Single cluster routing must be configured on the profile.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Enumerable<::Google::Cloud::Bigtable::V2::GenerateInitialChangeStreamPartitionsResponse>]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Enumerable<::Google::Cloud::Bigtable::V2::GenerateInitialChangeStreamPartitionsResponse>]
+            #
+            # @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::GenerateInitialChangeStreamPartitionsRequest.new
+            #
+            #   # Call the generate_initial_change_stream_partitions method to start streaming.
+            #   output = client.generate_initial_change_stream_partitions request
+            #
+            #   # The returned object is a streamed enumerable yielding elements of type
+            #   # ::Google::Cloud::Bigtable::V2::GenerateInitialChangeStreamPartitionsResponse
+            #   output.each do |current_response|
+            #     p current_response
+            #   end
+            #
+            def generate_initial_change_stream_partitions request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigtable::V2::GenerateInitialChangeStreamPartitionsRequest
+
+              # 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.generate_initial_change_stream_partitions.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.table_name
+                header_params["table_name"] = request.table_name
+              end
+
+              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              metadata[:"x-goog-request-params"] ||= request_params_header
+
+              options.apply_defaults timeout:      @config.rpcs.generate_initial_change_stream_partitions.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.generate_initial_change_stream_partitions.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @bigtable_stub.call_rpc :generate_initial_change_stream_partitions, 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
+
+            ##
+            # NOTE: This API is intended to be used by Apache Beam BigtableIO.
+            # Reads changes from a table's change stream. Changes will
+            # reflect both user-initiated mutations and mutations that are caused by
+            # garbage collection.
+            #
+            # @overload read_change_stream(request, options = nil)
+            #   Pass arguments to `read_change_stream` via a request object, either of type
+            #   {::Google::Cloud::Bigtable::V2::ReadChangeStreamRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::Bigtable::V2::ReadChangeStreamRequest, ::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 read_change_stream(table_name: nil, app_profile_id: nil, partition: nil, start_time: nil, continuation_tokens: nil, end_time: nil, heartbeat_duration: nil)
+            #   Pass arguments to `read_change_stream` 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 table_name [::String]
+            #     Required. The unique name of the table from which to read a change stream.
+            #     Values are of the form
+            #     `projects/<project>/instances/<instance>/tables/<table>`.
+            #     Change streaming must be enabled on the table.
+            #   @param app_profile_id [::String]
+            #     This value specifies routing for replication. If not specified, the
+            #     "default" application profile will be used.
+            #     Single cluster routing must be configured on the profile.
+            #   @param partition [::Google::Cloud::Bigtable::V2::StreamPartition, ::Hash]
+            #     The partition to read changes from.
+            #   @param start_time [::Google::Protobuf::Timestamp, ::Hash]
+            #     Start reading the stream at the specified timestamp. This timestamp must
+            #     be within the change stream retention period, less than or equal to the
+            #     current time, and after change stream creation, whichever is greater.
+            #     This value is inclusive and will be truncated to microsecond granularity.
+            #   @param continuation_tokens [::Google::Cloud::Bigtable::V2::StreamContinuationTokens, ::Hash]
+            #     Tokens that describe how to resume reading a stream where reading
+            #     previously left off. If specified, changes will be read starting at the
+            #     the position. Tokens are delivered on the stream as part of `Heartbeat`
+            #     and `CloseStream` messages.
+            #
+            #     If a single token is provided, the token’s partition must exactly match
+            #     the request’s partition. If multiple tokens are provided, as in the case
+            #     of a partition merge, the union of the token partitions must exactly
+            #     cover the request’s partition. Otherwise, INVALID_ARGUMENT will be
+            #     returned.
+            #   @param end_time [::Google::Protobuf::Timestamp, ::Hash]
+            #     If specified, OK will be returned when the stream advances beyond
+            #     this time. Otherwise, changes will be continuously delivered on the stream.
+            #     This value is inclusive and will be truncated to microsecond granularity.
+            #   @param heartbeat_duration [::Google::Protobuf::Duration, ::Hash]
+            #     If specified, the duration between `Heartbeat` messages on the stream.
+            #     Otherwise, defaults to 5 seconds.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Enumerable<::Google::Cloud::Bigtable::V2::ReadChangeStreamResponse>]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Enumerable<::Google::Cloud::Bigtable::V2::ReadChangeStreamResponse>]
+            #
+            # @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::ReadChangeStreamRequest.new
+            #
+            #   # Call the read_change_stream method to start streaming.
+            #   output = client.read_change_stream request
+            #
+            #   # The returned object is a streamed enumerable yielding elements of type
+            #   # ::Google::Cloud::Bigtable::V2::ReadChangeStreamResponse
+            #   output.each do |current_response|
+            #     p current_response
+            #   end
+            #
+            def read_change_stream request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigtable::V2::ReadChangeStreamRequest
+
+              # 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.read_change_stream.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.table_name
+                header_params["table_name"] = request.table_name
+              end
+
+              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              metadata[:"x-goog-request-params"] ||= request_params_header
+
+              options.apply_defaults timeout:      @config.rpcs.read_change_stream.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.read_change_stream.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @bigtable_stub.call_rpc :read_change_stream, 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
+
             ##
             # Configuration class for the Bigtable API.
             #
@@ -1058,6 +1285,16 @@ module Google
                 # @return [::Gapic::Config::Method]
                 #
                 attr_reader :read_modify_write_row
+                ##
+                # RPC-specific configuration for `generate_initial_change_stream_partitions`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :generate_initial_change_stream_partitions
+                ##
+                # RPC-specific configuration for `read_change_stream`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :read_change_stream
 
                 # @private
                 def initialize parent_rpcs = nil
@@ -1075,6 +1312,10 @@ module Google
                   @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
+                  generate_initial_change_stream_partitions_config = parent_rpcs.generate_initial_change_stream_partitions if parent_rpcs.respond_to? :generate_initial_change_stream_partitions
+                  @generate_initial_change_stream_partitions = ::Gapic::Config::Method.new generate_initial_change_stream_partitions_config
+                  read_change_stream_config = parent_rpcs.read_change_stream if parent_rpcs.respond_to? :read_change_stream
+                  @read_change_stream = ::Gapic::Config::Method.new read_change_stream_config
 
                   yield self if block_given?
                 end

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

@@ -33,7 +33,7 @@ module Google
         ##
         # Service for reading from and writing to existing Bigtable tables.
         #
-        # To load this service and instantiate a client:
+        # @example Load this service and instantiate a gRPC client
         #
         #     require "google/cloud/bigtable/v2/bigtable"
         #     client = ::Google::Cloud::Bigtable::V2::Bigtable::Client.new

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

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Bigtable
       module V2
-        VERSION = "0.7.1"
+        VERSION = "0.8.0"
       end
     end
   end

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

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