google-cloud-bigtable 2.2.0 → 2.5.0

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

@@ -15,6 +15,8 @@
 # limitations under the License.
 
 
+require "google/cloud/bigtable/encryption_info"
+
 module Google
   module Cloud
     module Bigtable
@@ -23,6 +25,20 @@ module Google
         # Table::ClusterState is the state of a table's data in a particular cluster.
         #
         # @attr [String] cluster_name The name of the cluster.
+        #
+        # @example Retrieve a table with cluster states.
+        #   require "google/cloud/bigtable"
+        #
+        #   bigtable = Google::Cloud::Bigtable.new
+        #
+        #   table = bigtable.table("my-instance", "my-table", view: :FULL, perform_lookup: true)
+        #
+        #   table.cluster_states.each do |cs|
+        #     puts cs.cluster_name
+        #     puts cs.replication_state
+        #     puts cs.encryption_infos.first.encryption_type
+        #   end
+        #
         class ClusterState
           attr_reader :cluster_name
 
@@ -36,7 +52,7 @@ module Google
 
           ##
           # The state of replication for the table in this cluster.
-          #   Valid values are:
+          #   Valid values include:
           #   * `:INITIALIZING` - The cluster was recently created.
           #   * `:PLANNED_MAINTENANCE` - The table is temporarily unable to serve.
           #   * `:UNPLANNED_MAINTENANCE` - The table is temporarily unable to serve.
@@ -45,6 +61,10 @@ module Google
           #     after a restore, and is being optimized for performance. When
           #     optimizations are complete, the table will transition to `READY`
           #     state.
+          #   * `:STATE_NOT_KNOWN` - If replication state is not present in the object
+          #      because the table view is not `REPLICATION_VIEW` or `FULL`.
+          #   * `:UNKNOWN` - If it could not be determined whether or not the table
+          #     has data in a particular cluster (for example, if its zone is unavailable.)
           #
           # @return [Symbol] The state of replication.
           #
@@ -57,7 +77,8 @@ module Google
           # over pre-existing data from other clusters before it can begin
           # receiving live replication updates and serving.
           #
-          # @return [Boolean] `true` if the table in this cluster is initializing.
+          # @return [Boolean] `true` if the value of {#replication_state} is `INITIALIZING`,
+          #   `false` otherwise.
           #
           def initializing?
             replication_state == :INITIALIZING
@@ -67,8 +88,8 @@ module Google
           # The table is temporarily unable to serve
           # requests from this cluster due to planned internal maintenance.
           #
-          # @return [Boolean] `true` if the table in this cluster is in planned
-          #   maintenance.
+          # @return [Boolean] `true` if the value of {#replication_state} is `PLANNED_MAINTENANCE`,
+          #   `false` otherwise.
           #
           def planned_maintenance?
             replication_state == :PLANNED_MAINTENANCE
@@ -78,8 +99,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 table in this cluster is in unplanned
-          #   maintenance.
+          # @return [Boolean] `true` if the value of {#replication_state} is `UNPLANNED_MAINTENANCE`,
+          #   `false` otherwise.
           #
           def unplanned_maintenance?
             replication_state == :UNPLANNED_MAINTENANCE
@@ -90,7 +111,8 @@ module Google
           # Depending on replication delay, reads may not immediately
           # reflect the state of the table in other clusters.
           #
-          # @return [Boolean] `true` if the table in this cluster is ready.
+          # @return [Boolean] `true` if the value of {#replication_state} is `READY`,
+          #   `false` otherwise.
           #
           def ready?
             replication_state == :READY
@@ -102,13 +124,25 @@ module Google
           # optimizations are complete, the table will transition to `READY`
           # state.
           #
-          # @return [Boolean] `true` if the table in this cluster is being
-          #   optimized.
+          # @return [Boolean] `true` if the value of {#replication_state} is `READY_OPTIMIZING`,
+          #   `false` otherwise.
           #
           def ready_optimizing?
             replication_state == :READY_OPTIMIZING
           end
 
+          ##
+          # The encryption info value objects for the table in this cluster. The encryption info
+          # is only present when the table view is `ENCRYPTION_VIEW` or `FULL`. See also
+          # {Instance::ClusterMap#add}.
+          #
+          # @return [Array<Google::Cloud::Bigtable::EncryptionInfo>] The array of encryption info
+          #   value objects, or an empty array if none are present.
+          #
+          def encryption_infos
+            @grpc.encryption_info.map { |ei_grpc| Google::Cloud::Bigtable::EncryptionInfo.from_grpc ei_grpc }
+          end
+
           # @private
           # New Table::ClusterState from a Google::Cloud::Bigtable::Admin::V2::Table::ClusterState object.
           # @param grpc [Google::Cloud::Bigtable::Admin::V2::Table::ClusterState]

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

@@ -114,12 +114,12 @@ module Google
           #     puts table.table_id
           #   end
           #
-          def all
+          def all &block
             return enum_for :all unless block_given?
 
             results = self
             loop do
-              results.each { |r| yield r }
+              results.each(&block)
               break unless next?
               grpc.next_page
               results = self.class.from_grpc grpc, service

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

@@ -108,7 +108,7 @@ module Google
           #   end
           #
           def table
-            Table.from_grpc results, service if results
+            Table.from_grpc results, service, view: :NAME_ONLY if results
           end
         end
       end

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

@@ -15,6 +15,8 @@
 # limitations under the License.
 
 
+require "google/cloud/bigtable/convert"
+
 module Google
   module Cloud
     module Bigtable
@@ -65,7 +67,9 @@ module Google
         ##
         # Sets the row range with the lower bound.
         #
-        # @param value [String] The value. Required.
+        # @param value [String, Integer] The value. Required. If the argument
+        #   is an Integer, it will be encoded as a 64-bit signed big-endian
+        #   integer.
         # @param inclusive [Boolean] Whether the value is an inclusive or
         #   exclusive lower bound. Default is `true`, an inclusive lower bound.
         # @return [Google::Cloud::Bigtable::ValueRange]
@@ -87,6 +91,8 @@ module Google
         #   range = table.new_value_range.from("value-001", inclusive: false)
         #
         def from value, inclusive: true
+          # If value is integer, covert it to a 64-bit signed big-endian integer.
+          value = Convert.integer_to_signed_be_64 value
           if inclusive
             @grpc.start_value_closed = value
           else
@@ -98,7 +104,9 @@ module Google
         ##
         # Sets the value range with upper bound.
         #
-        # @param value [String] value. Required
+        # @param value [String, Integer] value. Required. If the argument
+        #   is an Integer, it will be encoded as a 64-bit signed big-endian
+        #   integer.
         # @param inclusive [Boolean] Whether the value is an inclusive or
         #   exclusive lower bound. Default is `false`, an exclusive lower bound.
         # @return [Google::Cloud::Bigtable::ValueRange]
@@ -120,6 +128,8 @@ module Google
         #   range = table.new_value_range.to("value-010")
         #
         def to value, inclusive: false
+          # If value is integer, covert it to a 64-bit signed big-endian integer.
+          value = Convert.integer_to_signed_be_64 value
           if inclusive
             @grpc.end_value_closed = value
           else
@@ -131,8 +141,12 @@ module Google
         ##
         # Sets the value range with inclusive lower and upper bounds.
         #
-        # @param from_value [String] Inclusive from value. Required
-        # @param to_value [String] Inclusive to value. Required
+        # @param from_value [String, Integer] Inclusive from value. Required.
+        #   If the argument is an Integer, it will be encoded as a 64-bit
+        #   signed big-endian integer.
+        # @param to_value [String, Integer] Inclusive to value. Required.
+        #   If the argument is an Integer, it will be encoded as a 64-bit
+        #   signed big-endian integer.
         # @return [Google::Cloud::Bigtable::ValueRange]
         #   Range with inclusive from and to values.
         #
@@ -151,8 +165,12 @@ module Google
         ##
         # Set value range with an inclusive lower bound and an exclusive upper bound.
         #
-        # @param from_value [String] Inclusive from value
-        # @param to_value [String] Exclusive to value
+        # @param from_value [String, Integer] Inclusive from value. Required.
+        #   If the argument is an Integer, it will be encoded as a 64-bit
+        #   signed big-endian integer.
+        # @param to_value [String, Integer] Exclusive to value. Required.
+        #   If the argument is an Integer, it will be encoded as a 64-bit
+        #   signed big-endian integer.
         # @return [Google::Cloud::Bigtable::ValueRange]
         #   Range with an inclusive from value and an exclusive to value.
         #

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-bigtable
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-11 00:00:00.000000000 Z
+date: 2021-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-bigtable-admin-v2
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: 1.25.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: 1.25.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -197,6 +197,7 @@ files:
 - lib/google/cloud/bigtable/column_range.rb
 - lib/google/cloud/bigtable/convert.rb
 - lib/google/cloud/bigtable/credentials.rb
+- lib/google/cloud/bigtable/encryption_info.rb
 - lib/google/cloud/bigtable/errors.rb
 - lib/google/cloud/bigtable/gc_rule.rb
 - lib/google/cloud/bigtable/instance.rb
@@ -241,14 +242,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.13
 signing_key: 
 specification_version: 4
 summary: API Client library for Cloud Bigtable API