google-cloud-bigtable 1.3.0 → 2.3.0

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

@@ -137,8 +137,8 @@ module Google
           end
 
           # @private
-          # New Snapshot::List from a Google::Gax::PagedEnumerable<Google::Bigtable::Admin::V2::Backup> object.
-          # @param grpc [Google::Gax::PagedEnumerable<Google::Bigtable::Admin::V2::Backup> ]
+          # New Snapshot::List from a Gapic::PagedEnumerable<Google::Cloud::Bigtable::Admin::V2::Backup> object.
+          # @param grpc [Gapic::PagedEnumerable<Google::Cloud::Bigtable::Admin::V2::Backup> ]
           # @param service [Google::Cloud::Bigtable::Service]
           # @return [Array<Google::Cloud::Bigtable::Backup>]
           def self.from_grpc grpc, service

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

@@ -49,7 +49,7 @@ module Google
         ##
         # Process chunk and build full row with cells
         #
-        # @param chunk [Google::Bigtable::V2::ReadRowsResponse::CellChunk]
+        # @param chunk [Google::Cloud::Bigtable::V2::ReadRowsResponse::CellChunk]
         #
         def process chunk
           self.chunk = chunk

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

@@ -366,9 +366,9 @@ module Google
         # @private
         #
         # Creates a new Cluster instance from a
-        # Google::Bigtable::Admin::V2::Cluster.
+        # Google::Cloud::Bigtable::Admin::V2::Cluster.
         #
-        # @param grpc [Google::Bigtable::Admin::V2::Cluster]
+        # @param grpc [Google::Cloud::Bigtable::Admin::V2::Cluster]
         # @param service [Google::Cloud::Bigtable::Service]
         # @return [Google::Cloud::Bigtable::Cluster]
         def self.from_grpc grpc, service

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

@@ -142,7 +142,7 @@ module Google
 
           # @private
           #
-          # New Cluster::List from a Google::Bigtable::Admin::V2::ListClustersResponse object.
+          # New Cluster::List from a Google::Cloud::Bigtable::Admin::V2::ListClustersResponse object.
           def self.from_grpc grpc, service, instance_id: nil
             clusters = List.new(Array(grpc.clusters).map do |cluster|
               Cluster.from_grpc cluster, service

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

@@ -56,9 +56,9 @@ module Google
 
         # @private
         #
-        # Create a new ColumnFamily instance from a {Google::Bigtable::Admin::V2::ColumnFamily}.
+        # Create a new ColumnFamily instance from a {Google::Cloud::Bigtable::Admin::V2::ColumnFamily}.
         #
-        # @param grpc [Google::Bigtable::Admin::V2::ColumnFamily]
+        # @param grpc [Google::Cloud::Bigtable::Admin::V2::ColumnFamily]
         # @param name [String] Column family name
         # @return [Google::Cloud::Bigtable::ColumnFamily]
         #

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

@@ -211,7 +211,7 @@ module Google
             warn "The positional gc_rule argument is deprecated. Use the named gc_rule argument instead."
           end
 
-          column_family = Google::Bigtable::Admin::V2::ColumnFamily.new
+          column_family = Google::Cloud::Bigtable::Admin::V2::ColumnFamily.new
           column_family.gc_rule = gc_rule.to_grpc if gc_rule
           @column_families[name] = column_family
 
@@ -248,7 +248,7 @@ module Google
         def update name, gc_rule: nil
           raise ArgumentError, "column family #{name.inspect} does not exist" unless @column_families.has_key? name
 
-          column_family = Google::Bigtable::Admin::V2::ColumnFamily.new
+          column_family = Google::Cloud::Bigtable::Admin::V2::ColumnFamily.new
           column_family.gc_rule = gc_rule.to_grpc if gc_rule
           @column_families[name] = column_family
 
@@ -299,7 +299,7 @@ module Google
         #
         # @param comparison_map [Google::Protobuf::Map] The map to compare the
         #   current map against for building the modification entries.
-        # @return [Array<Google::Bigtable::Admin::V2::ModifyColumnFamiliesRequest::Modification>]
+        # @return [Array<Google::Cloud::Bigtable::Admin::V2::ModifyColumnFamiliesRequest::Modification>]
         #
         def modifications comparison_map = nil
           comparison_map ||= empty_map
@@ -352,7 +352,7 @@ module Google
         ##
         # Create an empty Google::Protobuf::Map suitable for column_families.
         def empty_map
-          Google::Bigtable::Admin::V2::Table.new.column_families
+          Google::Cloud::Bigtable::Admin::V2::Table.new.column_families
         end
 
         ##
@@ -362,13 +362,13 @@ module Google
         #
         # @param comparison_map [Google::Protobuf::Map] The map to compare the
         #   current map against for building the modification entries.
-        # @return [Array<Google::Bigtable::Admin::V2::ModifyColumnFamiliesRequest::Modification>]
+        # @return [Array<Google::Cloud::Bigtable::Admin::V2::ModifyColumnFamiliesRequest::Modification>]
         #
         def created_modifications comparison_map
           added_keys = @column_families.keys - comparison_map.keys
 
           added_keys.map do |name|
-            Google::Bigtable::Admin::V2::ModifyColumnFamiliesRequest:: \
+            Google::Cloud::Bigtable::Admin::V2::ModifyColumnFamiliesRequest:: \
             Modification.new(
               id:     name,
               create: @column_families[name]
@@ -383,7 +383,7 @@ module Google
         #
         # @param comparison_map [Google::Protobuf::Map] The map to compare the
         #   current map against for building the modification entries.
-        # @return [Array<Google::Bigtable::Admin::V2::ModifyColumnFamiliesRequest::Modification>]
+        # @return [Array<Google::Cloud::Bigtable::Admin::V2::ModifyColumnFamiliesRequest::Modification>]
         #
         def updated_modifications comparison_map
           possibly_updated_keys = @column_families.keys & comparison_map.keys
@@ -392,7 +392,7 @@ module Google
           end
 
           updated_keys.map do |name|
-            Google::Bigtable::Admin::V2::ModifyColumnFamiliesRequest:: \
+            Google::Cloud::Bigtable::Admin::V2::ModifyColumnFamiliesRequest:: \
             Modification.new(
               id:     name,
               update: @column_families[name]
@@ -407,13 +407,13 @@ module Google
         #
         # @param comparison_map [Google::Protobuf::Map] The map to compare the
         #   current map against for building the modification entries.
-        # @return [Array<Google::Bigtable::Admin::V2::ModifyColumnFamiliesRequest::Modification>]
+        # @return [Array<Google::Cloud::Bigtable::Admin::V2::ModifyColumnFamiliesRequest::Modification>]
         #
         def dropped_modifications comparison_map
           dropped_keys = comparison_map.keys - @column_families.keys
 
           dropped_keys.map do |name|
-            Google::Bigtable::Admin::V2::ModifyColumnFamiliesRequest:: \
+            Google::Cloud::Bigtable::Admin::V2::ModifyColumnFamiliesRequest:: \
             Modification.new(
               id:   name,
               drop: true

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

@@ -56,7 +56,7 @@ module Google
         # @param family [String] Column family name.
         #
         def initialize family
-          @grpc = Google::Bigtable::V2::ColumnRange.new family_name: family
+          @grpc = Google::Cloud::Bigtable::V2::ColumnRange.new family_name: family
         end
 
         ##
@@ -183,7 +183,7 @@ module Google
 
         # @private
         #
-        # @return [Google::Bigtable::V2::ColumnRange]
+        # @return [Google::Cloud::Bigtable::V2::ColumnRange]
         #
         def to_grpc
           @grpc

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

@@ -77,6 +77,18 @@ module Google
 
           Google::Protobuf::Timestamp.new seconds: time.to_i, nanos: time.nsec
         end
+
+        ##
+        # Converts an Integer to 64-bit signed big-endian integer data.
+        # Returns a string argument unchanged.
+        #
+        # @param value [String, Integer]
+        # @return [String]
+        #
+        def integer_to_signed_be_64 value
+          return [value].pack "q>" if value.is_a? Integer
+          value
+        end
       end
     end
   end

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

@@ -13,12 +13,46 @@
 # limitations under the License.
 
 
-require "google/cloud/bigtable/v2/credentials"
+require "google/cloud/bigtable/v2/bigtable/credentials"
 
 module Google
   module Cloud
     module Bigtable
-      class Credentials < Google::Cloud::Bigtable::V2::Credentials
+      ##
+      # # Credentials
+      #
+      # Represents the authentication and authorization used to connect to the
+      # Bigtable API.
+      #
+      # @example
+      #   require "google/cloud/bigtable"
+      #
+      #   keyfile = "/path/to/keyfile.json"
+      #   creds = Google::Cloud::Bigtable::Credentials.new keyfile
+      #
+      #   bigtable = Google::Cloud::Bigtable.new(
+      #     project_id: "my-project",
+      #     credentials: creds
+      #   )
+      #
+      #   bigtable.project_id #=> "my-project"
+      #
+      class Credentials < Google::Cloud::Bigtable::V2::Bigtable::Credentials
+        self.scope = [
+          "https://www.googleapis.com/auth/bigtable.admin",
+          "https://www.googleapis.com/auth/bigtable.admin.cluster",
+          "https://www.googleapis.com/auth/bigtable.admin.instance",
+          "https://www.googleapis.com/auth/bigtable.admin.table",
+          "https://www.googleapis.com/auth/bigtable.data",
+          "https://www.googleapis.com/auth/bigtable.data.readonly",
+          "https://www.googleapis.com/auth/cloud-bigtable.admin",
+          "https://www.googleapis.com/auth/cloud-bigtable.admin.cluster",
+          "https://www.googleapis.com/auth/cloud-bigtable.admin.table",
+          "https://www.googleapis.com/auth/cloud-bigtable.data",
+          "https://www.googleapis.com/auth/cloud-bigtable.data.readonly",
+          "https://www.googleapis.com/auth/cloud-platform",
+          "https://www.googleapis.com/auth/cloud-platform.read-only"
+        ]
       end
     end
   end

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

@@ -66,10 +66,10 @@ module Google
         # @private
         # Creates a new GC Rule instance.
         #
-        # @param grpc [Google::Bigtable::Admin::V2::GcRule | nil]
+        # @param grpc [Google::Cloud::Bigtable::Admin::V2::GcRule | nil]
         #
         def initialize grpc = nil
-          @grpc = grpc || Google::Bigtable::Admin::V2::GcRule.new
+          @grpc = grpc || Google::Cloud::Bigtable::Admin::V2::GcRule.new
         end
 
         ##
@@ -146,7 +146,7 @@ module Google
         #   List of GcRule with nested rules.
         #
         def intersection= rules
-          @grpc.intersection = Google::Bigtable::Admin::V2::GcRule::Intersection.new rules: rules.map(&:to_grpc)
+          @grpc.intersection = Google::Cloud::Bigtable::Admin::V2::GcRule::Intersection.new rules: rules.map(&:to_grpc)
         end
 
         ##
@@ -186,7 +186,7 @@ module Google
         #   List of GcRule with nested rules.
         #
         def union= rules
-          @grpc.union = Google::Bigtable::Admin::V2::GcRule::Union.new rules: rules.map(&:to_grpc)
+          @grpc.union = Google::Cloud::Bigtable::Admin::V2::GcRule::Union.new rules: rules.map(&:to_grpc)
         end
 
         ##
@@ -314,7 +314,7 @@ module Google
 
         # @private
         # Get gRPC instance of GC Rule
-        # @return [Google::Bigtable::Admin::V2::GcRule]
+        # @return [Google::Cloud::Bigtable::Admin::V2::GcRule]
         def to_grpc
           @grpc
         end
@@ -322,8 +322,8 @@ module Google
         # @private
         #
         # Creates a new GcRule instance from a
-        # Google::Bigtable::Admin::V2::GcRule.
-        # @param grpc [Google::Bigtable::Admin::V2::GcRule]
+        # Google::Cloud::Bigtable::Admin::V2::GcRule.
+        # @param grpc [Google::Cloud::Bigtable::Admin::V2::GcRule]
         # @return [Google::Cloud::Bigtable::GcRule]
         def self.from_grpc grpc
           new grpc

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

@@ -431,7 +431,7 @@ module Google
             location:             location
           }.delete_if { |_, v| v.nil? }
 
-          cluster = Google::Bigtable::Admin::V2::Cluster.new attrs
+          cluster = Google::Cloud::Bigtable::Admin::V2::Cluster.new attrs
           grpc = service.create_cluster instance_id, cluster_id, cluster
           Cluster::Job.from_grpc grpc, service
         end
@@ -509,8 +509,8 @@ module Google
         #
         #   entry = table.new_mutation_entry("user-1")
         #   entry.set_cell(
-        #     "cf-1",
-        #     "field-1",
+        #     "cf1",
+        #     "field1",
         #     "XYZ",
         #     timestamp: (Time.now.to_f * 1000000).round(-3) # microseconds
         #   ).delete_cells("cf2", "field02")
@@ -566,7 +566,7 @@ module Google
         #     * Tablet 3 : `[customer_1, customer_2) => {"customer_1"}`
         #     * Tablet 4 : `[customer_2, other)      => {"customer_2"}`
         #     * Tablet 5 : `[other, )                => {"other", "zz"}`
-        #   A hash in the form of `Google::Bigtable::Admin::V2::CreateTableRequest::Split`
+        #   A hash in the form of `Google::Cloud::Bigtable::Admin::V2::CreateTableRequest::Split`
         #   can also be provided.
         # @yield [column_families] A block for adding column families.
         # @yieldparam [Google::Cloud::Bigtable::ColumnFamilyMap] column_families
@@ -709,7 +709,7 @@ module Google
         def create_app_profile name, routing_policy, description: nil, etag: nil, ignore_warnings: false
           ensure_service!
           routing_policy_grpc = routing_policy.to_grpc
-          if routing_policy_grpc.is_a? Google::Bigtable::Admin::V2::AppProfile::MultiClusterRoutingUseAny
+          if routing_policy_grpc.is_a? Google::Cloud::Bigtable::Admin::V2::AppProfile::MultiClusterRoutingUseAny
             multi_cluster_routing = routing_policy_grpc
           else
             single_cluster_routing = routing_policy_grpc
@@ -725,7 +725,7 @@ module Google
           grpc = service.create_app_profile(
             instance_id,
             name,
-            Google::Bigtable::Admin::V2::AppProfile.new(app_profile_attrs),
+            Google::Cloud::Bigtable::Admin::V2::AppProfile.new(app_profile_attrs),
             ignore_warnings: ignore_warnings
           )
           AppProfile.from_grpc grpc, service
@@ -909,9 +909,9 @@ module Google
         # @private
         #
         # Creates a new Instance instance from a
-        # Google::Bigtable::Admin::V2::Instance.
+        # Google::Cloud::Bigtable::Admin::V2::Instance.
         #
-        # @param grpc [Google::Bigtable::Admin::V2::Instance]
+        # @param grpc [Google::Cloud::Bigtable::Admin::V2::Instance]
         # @param service [Google::Cloud::Bigtable::Service]
         # @return [Google::Cloud::Bigtable::Instance]
         #

data/lib/google/cloud/bigtable/instance/cluster_map.rb

@@ -65,7 +65,7 @@ module Google
               default_storage_type: storage_type
             }.delete_if { |_, v| v.nil? }
 
-            self[name] = Google::Bigtable::Admin::V2::Cluster.new attrs
+            self[name] = Google::Cloud::Bigtable::Admin::V2::Cluster.new attrs
           end
         end
       end

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

@@ -138,7 +138,7 @@ module Google
           end
 
           # @private
-          # New Instance::List from a Google::Bigtable::Admin::V2::Instance object.
+          # New Instance::List from a Google::Cloud::Bigtable::Admin::V2::Instance object.
           def self.from_grpc grpc, service
             instances = List.new(Array(grpc.instances).map do |instance|
               Instance.from_grpc instance, service

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

@@ -29,7 +29,7 @@ module Google
       #
       class LongrunningJob
         # @private
-        # The Google::Gax::Operation gRPC object.
+        # The Gapic::Operation gRPC object.
         attr_accessor :grpc
 
         # @private
@@ -109,7 +109,7 @@ module Google
         end
 
         # @private
-        # New BasicJob from a Google::Gax::Operation object.
+        # New BasicJob from a Gapic::Operation object.
         def self.from_grpc grpc, service
           new.tap do |job|
             job.grpc =  grpc

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

@@ -15,6 +15,8 @@
 # limitations under the License.
 
 
+require "google/cloud/bigtable/convert"
+
 module Google
   module Cloud
     module Bigtable
@@ -59,7 +61,7 @@ module Google
 
         # @private
         # mutations gRPC list
-        # @return [Array<Google::Bigtable::V2::Mutation>]
+        # @return [Array<Google::Cloud::Bigtable::V2::Mutation>]
         attr_accessor :mutations
 
         ##
@@ -84,8 +86,9 @@ module Google
         # @param qualifier [String] Column qualifier name.
         #   The qualifier of the column into which new data should be written.
         #   Can be any byte string, including an empty string.
-        # @param value [String, Integer] Cell value data.
-        #   The value to be written into the specified cell.
+        # @param value [String, Integer] Cell value data. The value to be written
+        #   into the specified cell. If the argument is an Integer, it will be
+        #   encoded as a 64-bit signed big-endian integer.
         # @param timestamp [Integer] Timestamp value in microseconds.
         #   The timestamp of the cell into which new data should be written.
         #   Use -1 for current Bigtable server time.
@@ -104,15 +107,15 @@ module Google
         # @example With timestamp.
         #   entry = Google::Cloud::Bigtable::MutationEntry.new("user-1")
         #   entry.set_cell(
-        #     "cf-1",
-        #     "field-1",
+        #     "cf1",
+        #     "field1",
         #     "XYZ",
         #     timestamp: (Time.now.to_f * 1000000).round(-3) # microseconds
         #   )
         #
         def set_cell family, qualifier, value, timestamp: nil
           # If value is integer, covert it to a 64-bit signed big-endian integer.
-          value = [value].pack "q>" if value.is_a? Integer
+          value = Convert.integer_to_signed_be_64 value
           options = {
             family_name:      family,
             column_qualifier: qualifier,
@@ -123,7 +126,7 @@ module Google
             options[:timestamp_micros] = timestamp
             @retryable = timestamp != -1
           end
-          @mutations << Google::Bigtable::V2::Mutation.new(set_cell: options)
+          @mutations << Google::Cloud::Bigtable::V2::Mutation.new(set_cell: options)
           self
         end
 
@@ -156,14 +159,14 @@ module Google
         #
         # @example Without timestamp range.
         #   entry = Google::Cloud::Bigtable::MutationEntry.new("user-1")
-        #   entry.delete_cells("cf-1", "field-1")
+        #   entry.delete_cells("cf1", "field1")
         #
         # @example With timestamp range.
         #   entry = Google::Cloud::Bigtable::MutationEntry.new("user-1")
         #   timestamp_micros = (Time.now.to_f * 1000000).round(-3)
         #   entry.delete_cells(
         #     "cf1",
-        #     "field-1",
+        #     "field1",
         #     timestamp_from: timestamp_micros - 5000000,
         #     timestamp_to: timestamp_micros
         #   )
@@ -172,19 +175,20 @@ module Google
         #   timestamp_micros = (Time.now.to_f * 1000000).round(-3)
         #   entry.delete_cells(
         #     "cf1",
-        #     "field-1",
+        #     "field1",
         #     timestamp_from: timestamp_micros - 5000000
         #   )
         #
         def delete_cells family, qualifier, timestamp_from: nil, timestamp_to: nil
-          grpc = Google::Bigtable::V2::Mutation::DeleteFromColumn.new family_name: family, column_qualifier: qualifier
+          grpc = Google::Cloud::Bigtable::V2::Mutation::DeleteFromColumn.new \
+            family_name: family, column_qualifier: qualifier
           if timestamp_from || timestamp_to
-            time_range = Google::Bigtable::V2::TimestampRange.new
+            time_range = Google::Cloud::Bigtable::V2::TimestampRange.new
             time_range.start_timestamp_micros = timestamp_from if timestamp_from
             time_range.end_timestamp_micros = timestamp_to if timestamp_to
             grpc.time_range = time_range
           end
-          @mutations << Google::Bigtable::V2::Mutation.new(delete_from_column: grpc)
+          @mutations << Google::Cloud::Bigtable::V2::Mutation.new(delete_from_column: grpc)
           self
         end
 
@@ -200,10 +204,10 @@ module Google
         #
         # @example
         #   entry = Google::Cloud::Bigtable::MutationEntry.new("user-1")
-        #   entry.delete_from_family("cf-1")
+        #   entry.delete_from_family("cf1")
         #
         def delete_from_family family
-          @mutations << Google::Bigtable::V2::Mutation.new(delete_from_family: { family_name: family })
+          @mutations << Google::Cloud::Bigtable::V2::Mutation.new(delete_from_family: { family_name: family })
           self
         end
 
@@ -219,7 +223,7 @@ module Google
         #   entry.delete_from_row
         #
         def delete_from_row
-          @mutations << Google::Bigtable::V2::Mutation.new(delete_from_row: {})
+          @mutations << Google::Cloud::Bigtable::V2::Mutation.new(delete_from_row: {})
           self
         end
 
@@ -245,10 +249,10 @@ module Google
         #
         # Convert mutation entry to gRPC protobuf object.
         #
-        # @return [Google::Bigtable::V2::MutateRowsRequest::Entry]
+        # @return [Google::Cloud::Bigtable::V2::MutateRowsRequest::Entry]
         #
         def to_grpc
-          Google::Bigtable::V2::MutateRowsRequest::Entry.new row_key: @row_key, mutations: @mutations
+          Google::Cloud::Bigtable::V2::MutateRowsRequest::Entry.new row_key: @row_key, mutations: @mutations
         end
       end
     end