google-cloud-bigtable 1.2.2 → 1.3.0

data/lib/google/bigtable/admin/v2/common_pb.rb

@@ -21,10 +21,10 @@ end
 module Google
   module Bigtable
     module Admin
-      module V2
-        OperationProgress = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.OperationProgress").msgclass
-        StorageType = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.StorageType").enummodule
-      end
     end
   end
 end
+module Google::Bigtable::Admin::V2
+  OperationProgress = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.OperationProgress").msgclass
+  StorageType = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.StorageType").enummodule
+end

data/lib/google/bigtable/admin/v2/instance_pb.rb

@@ -59,16 +59,16 @@ end
 module Google
   module Bigtable
     module Admin
-      module V2
-        Instance = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.Instance").msgclass
-        Instance::State = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.Instance.State").enummodule
-        Instance::Type = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.Instance.Type").enummodule
-        Cluster = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.Cluster").msgclass
-        Cluster::State = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.Cluster.State").enummodule
-        AppProfile = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.AppProfile").msgclass
-        AppProfile::MultiClusterRoutingUseAny = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.AppProfile.MultiClusterRoutingUseAny").msgclass
-        AppProfile::SingleClusterRouting = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.AppProfile.SingleClusterRouting").msgclass
-      end
     end
   end
 end
+module Google::Bigtable::Admin::V2
+  Instance = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.Instance").msgclass
+  Instance::State = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.Instance.State").enummodule
+  Instance::Type = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.Instance.Type").enummodule
+  Cluster = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.Cluster").msgclass
+  Cluster::State = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.Cluster.State").enummodule
+  AppProfile = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.AppProfile").msgclass
+  AppProfile::MultiClusterRoutingUseAny = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.AppProfile.MultiClusterRoutingUseAny").msgclass
+  AppProfile::SingleClusterRouting = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.AppProfile.SingleClusterRouting").msgclass
+end

data/lib/google/bigtable/admin/v2/table_pb.rb

@@ -104,24 +104,24 @@ end
 module Google
   module Bigtable
     module Admin
-      module V2
-        RestoreInfo = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.RestoreInfo").msgclass
-        Table = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.Table").msgclass
-        Table::ClusterState = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.Table.ClusterState").msgclass
-        Table::ClusterState::ReplicationState = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.Table.ClusterState.ReplicationState").enummodule
-        Table::TimestampGranularity = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.Table.TimestampGranularity").enummodule
-        Table::View = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.Table.View").enummodule
-        ColumnFamily = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.ColumnFamily").msgclass
-        GcRule = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.GcRule").msgclass
-        GcRule::Intersection = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.GcRule.Intersection").msgclass
-        GcRule::Union = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.GcRule.Union").msgclass
-        Snapshot = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.Snapshot").msgclass
-        Snapshot::State = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.Snapshot.State").enummodule
-        Backup = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.Backup").msgclass
-        Backup::State = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.Backup.State").enummodule
-        BackupInfo = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.BackupInfo").msgclass
-        RestoreSourceType = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.RestoreSourceType").enummodule
-      end
     end
   end
 end
+module Google::Bigtable::Admin::V2
+  RestoreInfo = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.RestoreInfo").msgclass
+  Table = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.Table").msgclass
+  Table::ClusterState = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.Table.ClusterState").msgclass
+  Table::ClusterState::ReplicationState = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.Table.ClusterState.ReplicationState").enummodule
+  Table::TimestampGranularity = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.Table.TimestampGranularity").enummodule
+  Table::View = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.Table.View").enummodule
+  ColumnFamily = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.ColumnFamily").msgclass
+  GcRule = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.GcRule").msgclass
+  GcRule::Intersection = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.GcRule.Intersection").msgclass
+  GcRule::Union = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.GcRule.Union").msgclass
+  Snapshot = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.Snapshot").msgclass
+  Snapshot::State = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.Snapshot.State").enummodule
+  Backup = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.Backup").msgclass
+  Backup::State = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.Backup.State").enummodule
+  BackupInfo = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.BackupInfo").msgclass
+  RestoreSourceType = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.RestoreSourceType").enummodule
+end

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

@@ -92,22 +92,22 @@ end
 
 module Google
   module Bigtable
-    module V2
-      ReadRowsRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.ReadRowsRequest").msgclass
-      ReadRowsResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.ReadRowsResponse").msgclass
-      ReadRowsResponse::CellChunk = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.ReadRowsResponse.CellChunk").msgclass
-      SampleRowKeysRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.SampleRowKeysRequest").msgclass
-      SampleRowKeysResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.SampleRowKeysResponse").msgclass
-      MutateRowRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.MutateRowRequest").msgclass
-      MutateRowResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.MutateRowResponse").msgclass
-      MutateRowsRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.MutateRowsRequest").msgclass
-      MutateRowsRequest::Entry = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.MutateRowsRequest.Entry").msgclass
-      MutateRowsResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.MutateRowsResponse").msgclass
-      MutateRowsResponse::Entry = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.MutateRowsResponse.Entry").msgclass
-      CheckAndMutateRowRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.CheckAndMutateRowRequest").msgclass
-      CheckAndMutateRowResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.CheckAndMutateRowResponse").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
-    end
   end
 end
+module Google::Bigtable::V2
+  ReadRowsRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.ReadRowsRequest").msgclass
+  ReadRowsResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.ReadRowsResponse").msgclass
+  ReadRowsResponse::CellChunk = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.ReadRowsResponse.CellChunk").msgclass
+  SampleRowKeysRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.SampleRowKeysRequest").msgclass
+  SampleRowKeysResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.SampleRowKeysResponse").msgclass
+  MutateRowRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.MutateRowRequest").msgclass
+  MutateRowResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.MutateRowResponse").msgclass
+  MutateRowsRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.MutateRowsRequest").msgclass
+  MutateRowsRequest::Entry = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.MutateRowsRequest.Entry").msgclass
+  MutateRowsResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.MutateRowsResponse").msgclass
+  MutateRowsResponse::Entry = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.MutateRowsResponse.Entry").msgclass
+  CheckAndMutateRowRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.CheckAndMutateRowRequest").msgclass
+  CheckAndMutateRowResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.CheckAndMutateRowResponse").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
+end

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

@@ -1,5 +1,5 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
-# Source: google/bigtable/v2/bigtable.proto for package 'google.bigtable.v2'
+# Source: google/bigtable/v2/bigtable.proto for package 'Google::Cloud::Bigtable::V2'
 # Original file comments:
 # Copyright 2019 Google LLC.
 #
@@ -22,47 +22,47 @@ require 'google/bigtable/v2/bigtable_pb'
 
 module Google
   module Bigtable
-    module V2
-      module Bigtable
-        # Service for reading from and writing to existing Bigtable tables.
-        class Service
-
-          include GRPC::GenericService
+  end
+end
+module Google::Bigtable::V2
+  module Bigtable
+    # Service for reading from and writing to existing Bigtable tables.
+    class Service
 
-          self.marshal_class_method = :encode
-          self.unmarshal_class_method = :decode
-          self.service_name = 'google.bigtable.v2.Bigtable'
+      include GRPC::GenericService
 
-          # Streams back the contents of all requested rows in key order, optionally
-          # applying the same Reader filter to each. Depending on their size,
-          # rows and cells may be broken up across multiple responses, but
-          # atomicity of each row will still be preserved. See the
-          # ReadRowsResponse documentation for details.
-          rpc :ReadRows, ReadRowsRequest, stream(ReadRowsResponse)
-          # Returns a sample of row keys in the table. The returned row keys will
-          # delimit contiguous sections of the table of approximately equal size,
-          # which can be used to break up the data for distributed tasks like
-          # mapreduces.
-          rpc :SampleRowKeys, SampleRowKeysRequest, stream(SampleRowKeysResponse)
-          # Mutates a row atomically. Cells already present in the row are left
-          # unchanged unless explicitly changed by `mutation`.
-          rpc :MutateRow, MutateRowRequest, MutateRowResponse
-          # Mutates multiple rows in a batch. Each individual row is mutated
-          # atomically as in MutateRow, but the entire batch is not executed
-          # atomically.
-          rpc :MutateRows, MutateRowsRequest, stream(MutateRowsResponse)
-          # Mutates a row atomically based on the output of a predicate Reader filter.
-          rpc :CheckAndMutateRow, CheckAndMutateRowRequest, CheckAndMutateRowResponse
-          # Modifies a row atomically on the server. The method reads the latest
-          # existing timestamp and value from the specified columns and writes a new
-          # entry based on pre-defined read/modify/write rules. The new value for the
-          # 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, ReadModifyWriteRowRequest, ReadModifyWriteRowResponse
-        end
+      self.marshal_class_method = :encode
+      self.unmarshal_class_method = :decode
+      self.service_name = 'google.bigtable.v2.Bigtable'
 
-        Stub = Service.rpc_stub_class
-      end
+      # Streams back the contents of all requested rows in key order, optionally
+      # applying the same Reader filter to each. Depending on their size,
+      # rows and cells may be broken up across multiple responses, but
+      # atomicity of each row will still be preserved. See the
+      # ReadRowsResponse documentation for details.
+      rpc :ReadRows, ReadRowsRequest, stream(ReadRowsResponse)
+      # Returns a sample of row keys in the table. The returned row keys will
+      # delimit contiguous sections of the table of approximately equal size,
+      # which can be used to break up the data for distributed tasks like
+      # mapreduces.
+      rpc :SampleRowKeys, SampleRowKeysRequest, stream(SampleRowKeysResponse)
+      # Mutates a row atomically. Cells already present in the row are left
+      # unchanged unless explicitly changed by `mutation`.
+      rpc :MutateRow, MutateRowRequest, MutateRowResponse
+      # Mutates multiple rows in a batch. Each individual row is mutated
+      # atomically as in MutateRow, but the entire batch is not executed
+      # atomically.
+      rpc :MutateRows, MutateRowsRequest, stream(MutateRowsResponse)
+      # Mutates a row atomically based on the output of a predicate Reader filter.
+      rpc :CheckAndMutateRow, CheckAndMutateRowRequest, CheckAndMutateRowResponse
+      # Modifies a row atomically on the server. The method reads the latest
+      # existing timestamp and value from the specified columns and writes a new
+      # entry based on pre-defined read/modify/write rules. The new value for the
+      # 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, ReadModifyWriteRowRequest, ReadModifyWriteRowResponse
     end
+
+    Stub = Service.rpc_stub_class
   end
 end

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

@@ -131,26 +131,26 @@ end
 
 module Google
   module Bigtable
-    module V2
-      Row = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.Row").msgclass
-      Family = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.Family").msgclass
-      Column = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.Column").msgclass
-      Cell = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.Cell").msgclass
-      RowRange = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.RowRange").msgclass
-      RowSet = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.RowSet").msgclass
-      ColumnRange = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.ColumnRange").msgclass
-      TimestampRange = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.TimestampRange").msgclass
-      ValueRange = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.ValueRange").msgclass
-      RowFilter = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.RowFilter").msgclass
-      RowFilter::Chain = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.RowFilter.Chain").msgclass
-      RowFilter::Interleave = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.RowFilter.Interleave").msgclass
-      RowFilter::Condition = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.RowFilter.Condition").msgclass
-      Mutation = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.Mutation").msgclass
-      Mutation::SetCell = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.Mutation.SetCell").msgclass
-      Mutation::DeleteFromColumn = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.Mutation.DeleteFromColumn").msgclass
-      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
-    end
   end
 end
+module Google::Bigtable::V2
+  Row = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.Row").msgclass
+  Family = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.Family").msgclass
+  Column = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.Column").msgclass
+  Cell = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.Cell").msgclass
+  RowRange = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.RowRange").msgclass
+  RowSet = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.RowSet").msgclass
+  ColumnRange = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.ColumnRange").msgclass
+  TimestampRange = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.TimestampRange").msgclass
+  ValueRange = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.ValueRange").msgclass
+  RowFilter = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.RowFilter").msgclass
+  RowFilter::Chain = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.RowFilter.Chain").msgclass
+  RowFilter::Interleave = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.RowFilter.Interleave").msgclass
+  RowFilter::Condition = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.RowFilter.Condition").msgclass
+  Mutation = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.Mutation").msgclass
+  Mutation::SetCell = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.Mutation.SetCell").msgclass
+  Mutation::DeleteFromColumn = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.v2.Mutation.DeleteFromColumn").msgclass
+  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
+end

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

@@ -97,7 +97,7 @@ module Google
           # @yield [app_profile] The block for accessing each app profile.
           # @yieldparam [AppProfile] app_profile The app profile object.
           #
-          # @return [Enumerator]
+          # @return [Enumerator,nil] An enumerator is returned if no block is given, otherwise `nil`.
           #
           # @example Iterating each app profile by passing a block:
           #   require "google/cloud/bigtable"
@@ -118,7 +118,7 @@ module Google
           #
           #   instance = bigtable.instance("my-instance")
           #
-          #   all_snapshot_ids = instance.app_profiles.all.map do |app_profile|
+          #   all_app_profile_ids = instance.app_profiles.all.map do |app_profile|
           #     app_profile.name
           #   end
           #

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

@@ -0,0 +1,324 @@
+# frozen_string_literal: true
+
+# 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.
+
+
+require "google/cloud/bigtable/backup/job"
+require "google/cloud/bigtable/backup/list"
+require "google/cloud/bigtable/convert"
+require "google/cloud/bigtable/table/restore_job"
+
+
+module Google
+  module Cloud
+    module Bigtable
+      ##
+      # # Backup
+      #
+      # A backup of a Cloud Bigtable table. See {Cluster#create_backup}, {Cluster#backup} and {Cluster#backups}.
+      #
+      # @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")
+      #
+      #   # Update
+      #   backup.expire_time = Time.now + 60 * 60 * 7
+      #   backup.save
+      #
+      #   # Delete
+      #   backup.delete
+      #
+      class Backup
+        # @private
+        # The gRPC Service object.
+        attr_accessor :service
+
+        ##
+        # @private A list of attributes that were updated.
+        attr_reader :updates
+
+        # @private
+        #
+        # Creates a new Backup instance.
+        def initialize grpc, service
+          @grpc = grpc
+          @service = service
+        end
+
+        ##
+        # The unique identifier for the project to which the backup belongs.
+        #
+        # @return [String]
+        #
+        def project_id
+          @grpc.name.split("/")[1]
+        end
+
+        ##
+        # The unique identifier for the instance to which the backup belongs.
+        #
+        # @return [String]
+        #
+        def instance_id
+          @grpc.name.split("/")[3]
+        end
+
+        ##
+        # The unique identifier for the cluster to which the backup belongs.
+        #
+        # @return [String]
+        #
+        def cluster_id
+          @grpc.name.split("/")[5]
+        end
+
+        ##
+        # The unique identifier for the backup.
+        #
+        # @return [String]
+        #
+        def backup_id
+          @grpc.name.split("/")[7]
+        end
+
+        ##
+        # The unique name of the backup. Value in the form
+        # `projects/<project>/instances/<instance>/clusters/<cluster>/backups/<backup>`.
+        #
+        # @return [String]
+        #
+        def path
+          @grpc.name
+        end
+
+        ##
+        # The table from which this backup was created.
+        #
+        # @param perform_lookup [Boolean] Creates table object without verifying that the table resource exists. Calls
+        #   made on this object will raise errors if the table does not exist. Default value is `false`. Optional. Helps
+        #   to reduce admin API calls.
+        # @param view [Symbol] Table view type. Default view type is `:SCHEMA_VIEW`. Valid view types are:
+        #
+        #   * `:NAME_ONLY` - Only populates `name`.
+        #   * `:SCHEMA_VIEW` - Only populates `name` and fields related to the table's schema.
+        #   * `:REPLICATION_VIEW` - Only populates `name` and fields related to the table's replication state.
+        #   * `:FULL` - Populates all fields.
+        #
+        # @return [Table]
+        #
+        def source_table perform_lookup: nil, view: nil
+          table = Table.from_path @grpc.source_table, service
+          return table.reload! view: view if perform_lookup
+          table
+        end
+
+        ##
+        # The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 30
+        # days from the time the request is received. Once the expire time has passed, Cloud Bigtable will delete the
+        # backup and free the resources used by the backup.
+        #
+        # @return [Time]
+        #
+        def expire_time
+          Convert.timestamp_to_time @grpc.expire_time
+        end
+
+        ##
+        # Sets the expiration time of the backup, with microseconds granularity that must be at least 6 hours and at
+        # most 30 days from the time the request is received. Once the {#expire_time} has passed, Cloud Bigtable will
+        # delete the backup and free the resources used by the backup.
+        #
+        # @param [Time] new_expire_time The new expiration time of the backup.
+        #
+        def expire_time= new_expire_time
+          @grpc.expire_time = Convert.time_to_timestamp new_expire_time
+        end
+
+        ##
+        # The time that the backup was started (i.e. approximately the time the `CreateBackup` request is received). The
+        # row data in this backup will be no older than this timestamp.
+        #
+        # @return [Time]
+        #
+        def start_time
+          Convert.timestamp_to_time @grpc.start_time
+        end
+
+        ##
+        # The time that the backup was finished. The row data in the backup will be no newer than this timestamp.
+        #
+        # @return [Time]
+        #
+        def end_time
+          Convert.timestamp_to_time @grpc.end_time
+        end
+
+        ##
+        # The size of the backup in bytes.
+        #
+        # @return [Integer]
+        #
+        def size_bytes
+          @grpc.size_bytes
+        end
+
+        ##
+        # The current state of the backup. Possible values are `:CREATING` and `:READY`.
+        #
+        # @return [Symbol]
+        #
+        def state
+          @grpc.state
+        end
+
+        ##
+        # The backup is currently being created, and may be destroyed if the creation process encounters an error.
+        #
+        # @return [Boolean]
+        #
+        def creating?
+          state == :CREATING
+        end
+
+        ##
+        # The backup has been successfully created and is ready to serve requests.
+        #
+        # @return [Boolean]
+        #
+        def ready?
+          state == :READY
+        end
+
+        ##
+        # Creates a new table by restoring from a completed backup.
+        #
+        # @param table_id [String] The table ID for the new table. This table must not yet exist. Required.
+        #
+        # @return [Google::Cloud::Bigtable::Table::RestoreJob] The job representing the long-running, asynchronous
+        #   processing of a backup restore table 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
+        #
+        def restore table_id
+          grpc = service.restore_table table_id, instance_id, cluster_id, backup_id
+          Table::RestoreJob.from_grpc grpc, service
+        end
+
+        ##
+        # Updates the backup.
+        #
+        # `expire_time` is the only updatable field.
+        #
+        # @return [Boolean] Returns `true` if the update succeeded.
+        #
+        # @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")
+        #
+        #   # Update
+        #   backup.expire_time = Time.now + 60 * 60 * 7
+        #   backup.save
+        #
+        def save
+          ensure_service!
+          @grpc = service.update_backup @grpc, [:expire_time]
+          true
+        end
+        alias update save
+
+        ##
+        # Reloads backup data.
+        #
+        # @return [Google::Cloud::Bigtable::Backup]
+        #
+        def reload!
+          @grpc = service.get_backup instance_id, cluster_id, backup_id
+          self
+        end
+
+        ##
+        # Permanently deletes the backup.
+        #
+        # @return [Boolean] Returns `true` if the backup was deleted.
+        #
+        # @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")
+        #
+        #   backup.delete
+        #
+        def delete
+          ensure_service!
+          service.delete_backup instance_id, cluster_id, backup_id
+          true
+        end
+
+        # @private
+        #
+        # Creates a new Backup instance from a Google::Bigtable::Admin::V2::Backup.
+        #
+        # @param grpc [Google::Bigtable::Admin::V2::Backup]
+        # @param service [Google::Cloud::Bigtable::Service]
+        # @return [Google::Cloud::Bigtable::Backup]
+        def self.from_grpc grpc, service
+          new grpc, service
+        end
+
+        protected
+
+        # @private
+        #
+        # Raise an error unless an active connection to the service is available.
+        def ensure_service!
+          raise "Must have active connection to service" unless service
+        end
+      end
+    end
+  end
+end