google-cloud-bigtable 2.6.0 → 2.10.1

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

@@ -33,9 +33,9 @@ module Google
       #
       #   bigtable = Google::Cloud::Bigtable.new
       #
-      #   instance = bigtable.instance("my-instance")
+      #   instance = bigtable.instance "my-instance"
       #
-      #   app_profile = instance.app_profile("my-app-profile")
+      #   app_profile = instance.app_profile "my-app-profile"
       #
       #   # Update
       #   app_profile.description = "User data instance app profile"
@@ -172,8 +172,8 @@ module Google
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
-        #   instance = bigtable.instance("my-instance")
-        #   app_profile = instance.app_profile("my-app-profile")
+        #   instance = bigtable.instance "my-instance"
+        #   app_profile = instance.app_profile "my-app-profile"
         #
         #   routing_policy = Google::Cloud::Bigtable::AppProfile.multi_cluster_routing
         #   app_profile.routing_policy = routing_policy
@@ -182,11 +182,11 @@ module Google
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
-        #   instance = bigtable.instance("my-instance")
-        #   app_profile = instance.app_profile("my-app-profile")
+        #   instance = bigtable.instance "my-instance"
+        #   app_profile = instance.app_profile "my-app-profile"
         #
         #   routing_policy = Google::Cloud::Bigtable::AppProfile.single_cluster_routing(
-        #     "my-instance-cluster-1",
+        #     "my-cluster",
         #     allow_transactional_writes: true
         #   )
         #   app_profile.routing_policy = routing_policy
@@ -225,7 +225,7 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   instance = bigtable.instance("my-instance")
+        #   instance = bigtable.instance "my-instance"
         #
         #   routing_policy = Google::Cloud::Bigtable::AppProfile.multi_cluster_routing
         #
@@ -253,11 +253,11 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   instance = bigtable.instance("my-instance")
+        #   instance = bigtable.instance "my-instance"
         #
-        #   app_profile = instance.app_profile("my-app-profile")
+        #   app_profile = instance.app_profile "my-app-profile"
         #
-        #   app_profile.delete(ignore_warnings: true) # Ignore warnings.
+        #   app_profile.delete ignore_warnings: true # Ignore warnings.
         #
         #   # OR : Not ignoring warnings
         #   app_profile.delete
@@ -281,20 +281,19 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   instance = bigtable.instance("my-instance")
+        #   instance = bigtable.instance "my-instance"
         #
-        #   app_profile = instance.app_profile("my-app-profile")
+        #   app_profile = instance.app_profile "my-app-profile"
         #
         #   app_profile.description = "User data instance app profile"
-        #   app_profile.routing_policy = \
-        #     Google::Cloud::Bigtable::AppProfile.multi_cluster_routing
+        #   app_profile.routing_policy = Google::Cloud::Bigtable::AppProfile.multi_cluster_routing
         #
         #   job = app_profile.save
         #   job.wait_until_done!
         #   if job.error?
         #     puts job.error
         #   else
-        #     puts "App profile successfully update."
+        #     puts "App profile successfully updated."
         #     app_profile = job.app_profile
         #   end
         #
@@ -303,8 +302,8 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   instance = bigtable.instance("my-instance")
-        #   app_profile = instance.app_profile("my-app-profile")
+        #   instance = bigtable.instance "my-instance"
+        #   app_profile = instance.app_profile "my-app-profile"
         #
         #   app_profile.description = "User data instance app profile"
         #   routing_policy = Google::Cloud::Bigtable::AppProfile.single_cluster_routing(
@@ -360,7 +359,7 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   instance = bigtable.instance("my-instance")
+        #   instance = bigtable.instance "my-instance"
         #
         #   routing_policy = Google::Cloud::Bigtable::AppProfile.multi_cluster_routing
         #
@@ -396,10 +395,10 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   instance = bigtable.instance("my-instance")
+        #   instance = bigtable.instance "my-instance"
         #
         #   routing_policy = Google::Cloud::Bigtable::AppProfile.single_cluster_routing(
-        #     "my-instance-cluster-1",
+        #     "my-cluster",
         #     allow_transactional_writes: true
         #   )
         #

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

@@ -34,12 +34,12 @@ module Google
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
-        #   instance = bigtable.instance("my-instance")
-        #   cluster = instance.cluster("my-cluster")
-        #   table = instance.table("my-table")
+        #   instance = bigtable.instance "my-instance"
+        #   cluster = instance.cluster "my-cluster"
+        #   table = instance.table "my-table"
         #
         #   expire_time = Time.now + 60 * 60 * 7
-        #   job = cluster.create_backup(table, "my-backup", expire_time)
+        #   job = cluster.create_backup table, "my-backup", expire_time
         #
         #   job.wait_until_done!
         #   job.done? #=> true
@@ -61,12 +61,12 @@ module Google
           #   require "google/cloud/bigtable"
           #
           #   bigtable = Google::Cloud::Bigtable.new
-          #   instance = bigtable.instance("my-instance")
-          #   cluster = instance.cluster("my-cluster")
-          #   table = instance.table("my-table")
+          #   instance = bigtable.instance "my-instance"
+          #   cluster = instance.cluster "my-cluster"
+          #   table = instance.table "my-table"
           #
           #   expire_time = Time.now + 60 * 60 * 7
-          #   job = cluster.create_backup(table, "my-backup", expire_time)
+          #   job = cluster.create_backup table, "my-backup", expire_time
           #
           #   job.wait_until_done!
           #   job.done? #=> true

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

@@ -46,8 +46,8 @@ module Google
           #
           #   bigtable = Google::Cloud::Bigtable.new
           #
-          #   instance = bigtable.instance("my-instance")
-          #   cluster = instance.cluster("my-cluster")
+          #   instance = bigtable.instance "my-instance"
+          #   cluster = instance.cluster "my-cluster"
           #
           #   backups = cluster.backups
           #
@@ -69,8 +69,8 @@ module Google
           #
           #   bigtable = Google::Cloud::Bigtable.new
           #
-          #   instance = bigtable.instance("my-instance")
-          #   cluster = instance.cluster("my-cluster")
+          #   instance = bigtable.instance "my-instance"
+          #   cluster = instance.cluster "my-cluster"
           #
           #   backups = cluster.backups
           #
@@ -105,8 +105,8 @@ module Google
           #
           #   bigtable = Google::Cloud::Bigtable.new
           #
-          #   instance = bigtable.instance("my-instance")
-          #   cluster = instance.cluster("my-cluster")
+          #   instance = bigtable.instance "my-instance"
+          #   cluster = instance.cluster "my-cluster"
           #
           #   cluster.backups.all do |backup|
           #     puts backup.backup_id
@@ -117,12 +117,10 @@ module Google
           #
           #   bigtable = Google::Cloud::Bigtable.new
           #
-          #   instance = bigtable.instance("my-instance")
-          #   cluster = instance.cluster("my-cluster")
+          #   instance = bigtable.instance "my-instance"
+          #   cluster = instance.cluster "my-cluster"
           #
-          #   all_backup_ids = cluster.backups.all.map do |backup|
-          #     backup.backup_id
-          #   end
+          #   all_backup_ids = cluster.backups.all.map(&:backup_id)
           #
           def all &block
             return enum_for :all unless block_given?

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

@@ -34,10 +34,10 @@ module Google
       #   require "google/cloud/bigtable"
       #
       #   bigtable = Google::Cloud::Bigtable.new
-      #   instance = bigtable.instance("my-instance")
-      #   cluster = instance.cluster("my-cluster")
+      #   instance = bigtable.instance "my-instance"
+      #   cluster = instance.cluster "my-cluster"
       #
-      #   backup = cluster.backup("my-backup")
+      #   backup = cluster.backup "my-backup"
       #
       #   # Update
       #   backup.expire_time = Time.now + 60 * 60 * 7
@@ -109,6 +109,18 @@ module Google
           @grpc.name
         end
 
+        ##
+        # The name of the backup from which this backup is copied.
+        # Value will be empty if its not a copied backup and of the form -
+        # `projects/<project>/instances/<instance>/clusters/<cluster>/backups/<source_backup>`
+        # if this is a copied backup.
+        #
+        # @return [String]
+        #
+        def source_backup
+          @grpc.source_backup
+        end
+
         ##
         # The table from which this backup was created.
         #
@@ -216,10 +228,10 @@ module Google
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
-        #   instance = bigtable.instance("my-instance")
-        #   cluster = instance.cluster("my-cluster")
+        #   instance = bigtable.instance "my-instance"
+        #   cluster = instance.cluster "my-cluster"
         #
-        #   backup = cluster.backup("my-backup")
+        #   backup = cluster.backup "my-backup"
         #
         #   encryption_info = backup.encryption_info
         #   encryption_info.encryption_type #=> :GOOGLE_DEFAULT_ENCRYPTION
@@ -247,10 +259,10 @@ module Google
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
-        #   instance = bigtable.instance("my-instance")
-        #   cluster = instance.cluster("my-cluster")
+        #   instance = bigtable.instance "my-instance"
+        #   cluster = instance.cluster "my-cluster"
         #
-        #   backup = cluster.backup("my-backup")
+        #   backup = cluster.backup "my-backup"
         #
         #   policy = backup.policy
         #
@@ -258,13 +270,13 @@ module Google
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
-        #   instance = bigtable.instance("my-instance")
-        #   cluster = instance.cluster("my-cluster")
+        #   instance = bigtable.instance "my-instance"
+        #   cluster = instance.cluster "my-cluster"
         #
-        #   backup = cluster.backup("my-backup")
+        #   backup = cluster.backup "my-backup"
         #
         #   backup.policy do |p|
-        #     p.add("roles/owner", "user:owner@example.com")
+        #     p.add "roles/owner", "user:owner@example.com"
         #   end # 2 API calls
         #
         def policy
@@ -294,14 +306,14 @@ module Google
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
-        #   instance = bigtable.instance("my-instance")
-        #   cluster = instance.cluster("my-cluster")
+        #   instance = bigtable.instance "my-instance"
+        #   cluster = instance.cluster "my-cluster"
         #
-        #   backup = cluster.backup("my-backup")
+        #   backup = cluster.backup "my-backup"
         #
         #   policy = backup.policy
-        #   policy.add("roles/owner", "user:owner@example.com")
-        #   updated_policy = backup.update_policy(policy)
+        #   policy.add "roles/owner", "user:owner@example.com"
+        #   updated_policy = backup.update_policy policy
         #
         #   puts updated_policy.roles
         #
@@ -330,10 +342,10 @@ module Google
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
-        #   instance = bigtable.instance("my-instance")
-        #   cluster = instance.cluster("my-cluster")
+        #   instance = bigtable.instance "my-instance"
+        #   cluster = instance.cluster "my-cluster"
         #
-        #   backup = cluster.backup("my-backup")
+        #   backup = cluster.backup "my-backup"
         #
         #   permissions = backup.test_iam_permissions(
         #     "bigtable.backups.delete",
@@ -363,12 +375,12 @@ module Google
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
-        #   instance = bigtable.instance("my-instance")
-        #   cluster = instance.cluster("my-cluster")
+        #   instance = bigtable.instance "my-instance"
+        #   cluster = instance.cluster "my-cluster"
         #
-        #   backup = cluster.backup("my-backup")
+        #   backup = cluster.backup "my-backup"
         #
-        #   job = backup.restore("my-new-table")
+        #   job = backup.restore "my-new-table"
         #
         #   job.wait_until_done!
         #   job.done? #=> true
@@ -384,13 +396,13 @@ module Google
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
-        #   instance = bigtable.instance("my-instance")
-        #   cluster = instance.cluster("my-cluster")
+        #   instance = bigtable.instance "my-instance"
+        #   cluster = instance.cluster "my-cluster"
         #
-        #   backup = cluster.backup("my-backup")
+        #   backup = cluster.backup "my-backup"
         #
-        #   table_instance = bigtable.instance("my-other-instance")
-        #   job = backup.restore("my-new-table", instance: table_instance)
+        #   table_instance = bigtable.instance "my-other-instance"
+        #   job = backup.restore "my-new-table", instance: table_instance
         #
         #   job.wait_until_done!
         #   job.done? #=> true
@@ -412,6 +424,61 @@ module Google
           Table::RestoreJob.from_grpc grpc, service
         end
 
+        ##
+        # Creates a copy of the backup at the desired location. Copy of the backup won't be created
+        # if the backup is already a copied one.
+        #
+        # @param dest_project_id [String] Existing project ID. Copy of the backup
+        #   will be created in this project. Required.
+        # @param dest_instance_id [Instance, String] Existing instance ID. Copy
+        #   of the backup will be created in this instance. Required.
+        # @param dest_cluster_id [String] Existing cluster ID. Copy of the backup
+        #   will be created in this cluster. Required.
+        # @param new_backup_id [String] The id of the copy of the backup to be created. This string must
+        #   be between 1 and 50 characters in length and match the regex
+        #   `[_a-zA-Z0-9][-_.a-zA-Z0-9]*`. Required.
+        # @param expire_time [Time] The expiration time of the copy 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. Required.
+        #
+        # @return [Google::Cloud::Bigtable::Backup::Job] The job representing the long-running, asynchronous
+        #   processing of a copy backup operation.
+        #
+        # @example Create a copy of the backup at a specific location
+        #   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.copy dest_project_id:"my-project-2",
+        #                     dest_instance_id:"my-instance-2",
+        #                     dest_cluster_id:"my-cluster-2",
+        #                     new_backup_id:"my-backup-2",
+        #                     expire_time: Time.now + 60 * 60 * 7
+        #
+        #   job.wait_until_done!
+        #   job.done? #=> true
+        #
+        #   if job.error?
+        #     status = job.error
+        #   else
+        #     backup = job.backup
+        #   end
+        #
+        def copy dest_project_id:, dest_instance_id:, dest_cluster_id:, new_backup_id:, expire_time:
+          grpc = service.copy_backup project_id: dest_project_id,
+                                     instance_id: dest_instance_id,
+                                     cluster_id: dest_cluster_id,
+                                     backup_id: new_backup_id,
+                                     source_backup: service.backup_path(instance_id, cluster_id, backup_id),
+                                     expire_time: expire_time
+          Backup::Job.from_grpc grpc, service
+        end
+
         ##
         # Updates the backup.
         #
@@ -423,10 +490,10 @@ module Google
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
-        #   instance = bigtable.instance("my-instance")
-        #   cluster = instance.cluster("my-cluster")
+        #   instance = bigtable.instance "my-instance"
+        #   cluster = instance.cluster "my-cluster"
         #
-        #   backup = cluster.backup("my-backup")
+        #   backup = cluster.backup "my-backup"
         #
         #   # Update
         #   backup.expire_time = Time.now + 60 * 60 * 7
@@ -458,10 +525,10 @@ module Google
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
-        #   instance = bigtable.instance("my-instance")
-        #   cluster = instance.cluster("my-cluster")
+        #   instance = bigtable.instance "my-instance"
+        #   cluster = instance.cluster "my-cluster"
         #
-        #   backup = cluster.backup("my-backup")
+        #   backup = cluster.backup "my-backup"
         #
         #   backup.delete
         #

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

@@ -76,11 +76,11 @@ module Google
         def validate_reset_row
           return unless chunk.reset_row
 
-          value = (!chunk.row_key.empty? ||
-              chunk.family_name ||
-              chunk.qualifier ||
-              !chunk.value.empty? ||
-              chunk.timestamp_micros.positive?)
+          value = !chunk.row_key.empty? ||
+                  chunk.family_name ||
+                  chunk.qualifier ||
+                  !chunk.value.empty? ||
+                  chunk.timestamp_micros.positive?
 
           raise_if value, "A reset should have no data"
         end

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

@@ -34,7 +34,7 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   instance = bigtable.instance("my-instance")
+        #   instance = bigtable.instance "my-instance"
         #   job = instance.create_cluster(
         #     "my-new-cluster",
         #     "us-east-1b",
@@ -67,7 +67,7 @@ module Google
           #
           #   bigtable = Google::Cloud::Bigtable.new
           #
-          #   instance = bigtable.instance("my-instance")
+          #   instance = bigtable.instance "my-instance"
           #   job = instance.create_cluster(
           #     "my-new-cluster",
           #     "us-east-1b",

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

@@ -33,8 +33,8 @@ module Google
       #
       #   bigtable = Google::Cloud::Bigtable.new
       #
-      #   instance = bigtable.instance("my-instance")
-      #   cluster = instance.cluster("my-cluster")
+      #   instance = bigtable.instance "my-instance"
+      #   cluster = instance.cluster "my-cluster"
       #
       #   # Update
       #   cluster.nodes = 3
@@ -239,12 +239,12 @@ module Google
         #   require "google/cloud/bigtable"
         #
         #   bigtable = Google::Cloud::Bigtable.new
-        #   instance = bigtable.instance("my-instance")
-        #   cluster = instance.cluster("my-cluster")
-        #   table = instance.table("my-table")
+        #   instance = bigtable.instance "my-instance"
+        #   cluster = instance.cluster "my-cluster"
+        #   table = instance.table "my-table"
         #
         #   expire_time = Time.now + 60 * 60 * 7
-        #   job = cluster.create_backup(table, "my-backup", expire_time)
+        #   job = cluster.create_backup table, "my-backup", expire_time
         #
         #   job.wait_until_done!
         #   job.done? #=> true
@@ -277,10 +277,10 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   instance = bigtable.instance("my-instance")
-        #   cluster = instance.cluster("my-cluster")
+        #   instance = bigtable.instance "my-instance"
+        #   cluster = instance.cluster "my-cluster"
         #
-        #   backup = cluster.backup("my-backup")
+        #   backup = cluster.backup "my-backup"
         #
         #   if backup
         #     puts backup.backup_id
@@ -303,8 +303,8 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   instance = bigtable.instance("my-instance")
-        #   cluster = instance.cluster("my-cluster")
+        #   instance = bigtable.instance "my-instance"
+        #   cluster = instance.cluster "my-cluster"
         #
         #   cluster.backups.all do |backup|
         #     puts backup.backup_id
@@ -329,8 +329,8 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   instance = bigtable.instance("my-instance")
-        #   cluster = instance.cluster("my-cluster")
+        #   instance = bigtable.instance "my-instance"
+        #   cluster = instance.cluster "my-cluster"
         #   cluster.nodes = 3
         #   job = cluster.save
         #
@@ -373,8 +373,8 @@ module Google
         #
         #   bigtable = Google::Cloud::Bigtable.new
         #
-        #   instance = bigtable.instance("my-instance")
-        #   cluster = instance.cluster("my-cluster")
+        #   instance = bigtable.instance "my-instance"
+        #   cluster = instance.cluster "my-cluster"
         #   cluster.delete
         #
         def delete

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

@@ -30,8 +30,8 @@ module Google
       #
       #   bigtable = Google::Cloud::Bigtable.new
       #
-      #   instance = bigtable.instance("my-instance")
-      #   table = instance.table("my-table")
+      #   instance = bigtable.instance "my-instance"
+      #   table = instance.table "my-table"
       #
       #   column_family = table.column_families["cf2"]
       #   puts column_family.gc_rule