google-cloud-bigtable 1.2.2 → 1.3.0

data/lib/google/cloud/bigtable/table/cluster_state.rb

@@ -21,6 +21,8 @@ module Google
       class Table
         ##
         # Table::ClusterState is the state of a table's data in a particular cluster.
+        #
+        # @attr [String] cluster_name The name of the cluster.
         class ClusterState
           attr_reader :cluster_name
 
@@ -39,6 +41,10 @@ module Google
           #   * `:PLANNED_MAINTENANCE` - The table is temporarily unable to serve.
           #   * `:UNPLANNED_MAINTENANCE` - The table is temporarily unable to serve.
           #   * `:READY` - The table can serve.
+          #   * `:READY_OPTIMIZING` - The table is fully created and ready for use
+          #     after a restore, and is being optimized for performance. When
+          #     optimizations are complete, the table will transition to `READY`
+          #     state.
           #
           # @return [Symbol] The state of replication.
           #
@@ -51,7 +57,7 @@ module Google
           # over pre-existing data from other clusters before it can begin
           # receiving live replication updates and serving.
           #
-          # @return [Boolean] `true` if the cluster is initializing.
+          # @return [Boolean] `true` if the table in this cluster is initializing.
           #
           def initializing?
             replication_state == :INITIALIZING
@@ -61,7 +67,8 @@ module Google
           # The table is temporarily unable to serve
           # requests from this cluster due to planned internal maintenance.
           #
-          # @return [Boolean] `true` if the cluster is in planned maintenance.
+          # @return [Boolean] `true` if the table in this cluster is in planned
+          #   maintenance.
           #
           def planned_maintenance?
             replication_state == :PLANNED_MAINTENANCE
@@ -71,7 +78,8 @@ module Google
           # The table is temporarily unable to serve requests from this
           # cluster due to unplanned or emergency maintenance.
           #
-          # @return [Boolean] `true` if the cluster is in unplanned maintenance.
+          # @return [Boolean] `true` if the table in this cluster is in unplanned
+          #   maintenance.
           #
           def unplanned_maintenance?
             replication_state == :UNPLANNED_MAINTENANCE
@@ -82,12 +90,25 @@ module Google
           # Depending on replication delay, reads may not immediately
           # reflect the state of the table in other clusters.
           #
-          # @return [Boolean] `true` if the cluster is ready.
+          # @return [Boolean] `true` if the table in this cluster is ready.
           #
           def ready?
             replication_state == :READY
           end
 
+          ##
+          # The table is fully created and ready for use after a
+          # restore, and is being optimized for performance. When
+          # optimizations are complete, the table will transition to `READY`
+          # state.
+          #
+          # @return [Boolean] `true` if the table in this cluster is being
+          #   optimized.
+          #
+          def ready_optimizing?
+            replication_state == :READY_OPTIMIZING
+          end
+
           # @private
           # New Table::ClusterState from a Google::Bigtable::Admin::V2::Table::ClusterState object.
           # @param grpc [Google::Bigtable::Admin::V2::Table::ClusterState]

data/lib/google/cloud/bigtable/table/list.rb

@@ -94,7 +94,7 @@ module Google
           # @yield [table] The block for accessing each table instance.
           # @yieldparam [Table] table The table instance object.
           #
-          # @return [Enumerator]
+          # @return [Enumerator,nil] An enumerator is returned if no block is given, otherwise `nil`.
           #
           # @example Iterating each table by passing a block:
           #   require "google/cloud/bigtable"

data/lib/google/cloud/bigtable/table/restore_job.rb

@@ -0,0 +1,117 @@
+# Copyright 2020 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.
+
+
+module Google
+  module Cloud
+    module Bigtable
+      class Table
+        ##
+        # # RestoreJob
+        #
+        # A resource representing the long-running, asynchronous processing of a backup restore operation. The
+        # job can be refreshed to retrieve the table object once the operation has been completed.
+        #
+        # See {Backup#restore}.
+        #
+        # @see https://cloud.google.com/bigtable/docs/reference/admin/rpc/google.longrunning#google.longrunning.Operation
+        #   Long-running Operation
+        #
+        # @example
+        #   require "google/cloud/bigtable"
+        #
+        #   bigtable = Google::Cloud::Bigtable.new
+        #   instance = bigtable.instance("my-instance")
+        #   cluster = instance.cluster("my-cluster")
+        #
+        #   backup = cluster.backup("my-backup")
+        #
+        #   job = backup.restore("my-new-table")
+        #
+        #   job.wait_until_done!
+        #   job.done? #=> true
+        #
+        #   if job.error?
+        #     status = job.error
+        #   else
+        #     table = job.table
+        #     optimized = job.optimize_table_operation_name
+        #   end
+        #
+        class RestoreJob < LongrunningJob
+          ##
+          # The optimize table operation name from operation metadata.
+          #
+          # @return [String, nil] The optimize table operation name, or `nil` if the optimize table operation is not
+          #   complete.
+          #
+          # @example
+          #   require "google/cloud/bigtable"
+          #
+          #   bigtable = Google::Cloud::Bigtable.new
+          #   instance = bigtable.instance("my-instance")
+          #   cluster = instance.cluster("my-cluster")
+          #
+          #   backup = cluster.backup("my-backup")
+          #
+          #   job = backup.restore("my-new-table")
+          #
+          #   job.wait_until_done!
+          #   job.done? #=> true
+          #
+          #   if job.error?
+          #     status = job.error
+          #   else
+          #     table = job.table
+          #     optimized = job.optimize_table_operation_name
+          #   end
+          #
+          def optimize_table_operation_name
+            metadata.optimize_table_operation_name
+          end
+
+          ##
+          # Gets the table object from operation results.
+          #
+          # @return [Google::Cloud::Bigtable::Table, nil] The table instance, or `nil` if the operation is not complete.
+          #
+          # @example
+          #   require "google/cloud/bigtable"
+          #
+          #   bigtable = Google::Cloud::Bigtable.new
+          #   instance = bigtable.instance("my-instance")
+          #   cluster = instance.cluster("my-cluster")
+          #
+          #   backup = cluster.backup("my-backup")
+          #
+          #   job = backup.restore("my-new-table")
+          #
+          #   job.wait_until_done!
+          #   job.done? #=> true
+          #
+          #   if job.error?
+          #     status = job.error
+          #   else
+          #     table = job.table
+          #     optimized = job.optimize_table_operation_name
+          #   end
+          #
+          def table
+            Table.from_grpc results, service if results
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Bigtable
-      VERSION = "1.2.2".freeze
+      VERSION = "1.3.0".freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-bigtable
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-28 00:00:00.000000000 Z
+date: 2020-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -258,6 +258,9 @@ files:
 - lib/google/cloud/bigtable/app_profile.rb
 - lib/google/cloud/bigtable/app_profile/job.rb
 - lib/google/cloud/bigtable/app_profile/list.rb
+- lib/google/cloud/bigtable/backup.rb
+- lib/google/cloud/bigtable/backup/job.rb
+- lib/google/cloud/bigtable/backup/list.rb
 - lib/google/cloud/bigtable/chunk_processor.rb
 - lib/google/cloud/bigtable/cluster.rb
 - lib/google/cloud/bigtable/cluster/job.rb
@@ -296,6 +299,7 @@ files:
 - lib/google/cloud/bigtable/table.rb
 - lib/google/cloud/bigtable/table/cluster_state.rb
 - lib/google/cloud/bigtable/table/list.rb
+- lib/google/cloud/bigtable/table/restore_job.rb
 - lib/google/cloud/bigtable/v2.rb
 - lib/google/cloud/bigtable/v2/bigtable_client.rb
 - lib/google/cloud/bigtable/v2/bigtable_client_config.json
@@ -326,7 +330,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.3
 signing_key: 
 specification_version: 4
 summary: API Client library for Cloud Bigtable API