google-cloud-bigtable 1.2.2 → 2.2.1

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/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

@@ -106,7 +106,7 @@ module Google
           # @yield [instance] The block for accessing each instance.
           # @yieldparam [Instance] instance The instance object.
           #
-          # @return [Enumerator]
+          # @return [Enumerator,nil] An enumerator is returned if no block is given, otherwise `nil`.
           #
           # @example Iterating each instance by passing a block:
           #   require "google/cloud/bigtable"
@@ -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
@@ -97,8 +97,19 @@ module Google
           @grpc.wait_until_done!
         end
 
+        ##
+        # @private Gets the metadata object of the operation.
+        #
+        # @return [Object, nil] `nil` if the operation is not complete.
+        #
+        def metadata
+          return nil unless done?
+          return nil unless @grpc.grpc_op.result == :response
+          @grpc.metadata
+        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

@@ -59,7 +59,7 @@ module Google
 
         # @private
         # mutations gRPC list
-        # @return [Array<Google::Bigtable::V2::Mutation>]
+        # @return [Array<Google::Cloud::Bigtable::V2::Mutation>]
         attr_accessor :mutations
 
         ##
@@ -104,8 +104,8 @@ 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
         #   )
@@ -123,7 +123,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 +156,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 +172,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 +201,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 +220,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 +246,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

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

@@ -65,8 +65,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")
@@ -89,7 +89,7 @@ module Google
         #   applied in arbitrary order (even between entries for the same row).
         #   At least one entry must be specified, and in total the entries can
         #   contain a maximum of 100,000 mutations.
-        # @return [Array<Google::Bigtable::V2::MutateRowsResponse::Entry>]
+        # @return [Array<Google::Cloud::Bigtable::V2::MutateRowsResponse::Entry>]
         #
         # @example
         #   require "google/cloud/bigtable"
@@ -219,8 +219,8 @@ module Google
         #   predicate_filter = Google::Cloud::Bigtable::RowFilter.key("user-10")
         #   on_match_mutations = Google::Cloud::Bigtable::MutationEntry.new
         #   on_match_mutations.set_cell(
-        #     "cf-1",
-        #     "field-1",
+        #     "cf1",
+        #     "field1",
         #     "XYZ",
         #     timestamp: (Time.now.to_f * 1000000).round(-3) # microseconds
         #   ).delete_cells("cf2", "field02")
@@ -346,7 +346,7 @@ module Google
 
           ##
           # @private New MutationEntry::Response from a
-          # Google::Bigtable::V2::MutateRowsResponse::Entry object.
+          # Google::Cloud::Bigtable::V2::MutateRowsResponse::Entry object.
           def self.from_grpc grpc
             new grpc.index, Status.from_grpc(grpc.status)
           end

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

@@ -227,7 +227,7 @@ module Google
           labels = Hash[labels.map { |k, v| [String(k), String(v)] }] if labels
 
           instance_attrs = { display_name: display_name, type: type, labels: labels }.delete_if { |_, v| v.nil? }
-          instance = Google::Bigtable::Admin::V2::Instance.new instance_attrs
+          instance = Google::Cloud::Bigtable::Admin::V2::Instance.new instance_attrs
           clusters ||= Instance::ClusterMap.new
           yield clusters if block_given?
 

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

@@ -44,7 +44,7 @@ module Google
         #   The qualifier of the column to which the read/modify/write should be applied.
         #
         def initialize family, qualifier
-          @grpc = Google::Bigtable::V2::ReadModifyWriteRule.new
+          @grpc = Google::Cloud::Bigtable::V2::ReadModifyWriteRule.new
           @grpc.family_name = family
           @grpc.column_qualifier = qualifier
         end
@@ -123,7 +123,7 @@ module Google
         #
         # Get gRPC protobuf instance.
         #
-        # @return [Google::Bigtable::V2::ReadModifyWriteRule]
+        # @return [Google::Cloud::Bigtable::V2::ReadModifyWriteRule]
         #
         def to_grpc
           @grpc

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

@@ -309,7 +309,7 @@ module Google
         #
         # @param row_keys [Array<String>]
         # @param row_ranges [Google::Cloud::Bigtable::RowRange | Array<Google::Cloud::Bigtable::RowRange>]
-        # @return [Google::Bigtable::V2::RowSet]
+        # @return [Google::Cloud::Bigtable::V2::RowSet]
         #
         def build_row_set row_keys, row_ranges
           row_set = {}
@@ -320,7 +320,7 @@ module Google
             row_set[:row_ranges] = row_ranges.map(&:to_grpc)
           end
 
-          Google::Bigtable::V2::RowSet.new row_set
+          Google::Cloud::Bigtable::V2::RowSet.new row_set
         end
       end
     end

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

@@ -99,7 +99,7 @@ module Google
       class MultiClusterRoutingUseAny < RoutingPolicy
         # @private
         def to_grpc
-          Google::Bigtable::Admin::V2::AppProfile::MultiClusterRoutingUseAny.new
+          Google::Cloud::Bigtable::Admin::V2::AppProfile::MultiClusterRoutingUseAny.new
         end
       end
 
@@ -161,7 +161,7 @@ module Google
 
         # @private
         def to_grpc
-          Google::Bigtable::Admin::V2::AppProfile::SingleClusterRouting.new(
+          Google::Cloud::Bigtable::Admin::V2::AppProfile::SingleClusterRouting.new(
             cluster_id:                 cluster_id,
             allow_transactional_writes: allow_transactional_writes
           )

data/lib/google/cloud/bigtable/row_filter/chain_filter.rb

@@ -564,11 +564,11 @@ module Google
           #
           # Gets a gRPC object of RowFilter with a chain filter.
           #
-          # @return [Google::Bigtable::V2::RowFilter]
+          # @return [Google::Cloud::Bigtable::V2::RowFilter]
           #
           def to_grpc
-            Google::Bigtable::V2::RowFilter.new(
-              chain: Google::Bigtable::V2::RowFilter::Chain.new(filters: @filters.map(&:to_grpc))
+            Google::Cloud::Bigtable::V2::RowFilter.new(
+              chain: Google::Cloud::Bigtable::V2::RowFilter::Chain.new(filters: @filters.map(&:to_grpc))
             )
           end