google-cloud-bigtable 2.7.1 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67e534271f2a313216bfb3d54e7a5ac84dec994ee4f42da33a81a0ecd9ab1230
-  data.tar.gz: 6a4e80bf21ded6b239f26a59fbb51997a3f32130454787ff0c15136841ce8c45
+  metadata.gz: 735e0a2c4fcb24227bbdf5e7f1ee76d6e8f718b6d23cf30bdf56fd8c6f13f830
+  data.tar.gz: fd7c5cb8fa45cd44a7e0a39c78a88bf63e52214c133505dbfbc2977a86b89cd0
 SHA512:
-  metadata.gz: 0cd1d97d9bb9663ccb56653cb6de6e60062ad9f9bb2ff8a3c010f12dab27d0ef93fb5ce38c3fefc1830df60857cb2fb26189c6bb6c15c21a53b5149b170f7040
-  data.tar.gz: d0407fd6d9f71869bc1e3a2897ab83d6de5b65c9c94a14332bb4d557de17c7c9e20cb2c74fd3e005fedb53917db02c098236d96e8aaf2213d101b2760bf0af4c
+  metadata.gz: 2ee38cb00b572386d02f7b7f4f7abd593b0d8022e4dd366a54b2789bf8f4e8ee04b73a9ece3286707a81ce68006fb8f2f84685a721057c16b607911e4d8da5e2
+  data.tar.gz: a9686ba49ac1a4761761570f0486edcbb6d628eaaa5c8183df65b6f697c9f50022abf8b61f7420f6b79b5f7e00ad4b9a99f1f0f45266ca248fc47ae8e874ec5a

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Release History
 
+### 2.8.0 (2023-08-17)
+
+#### Features
+
+* Added support for copybackup ([#19341](https://github.com/googleapis/google-cloud-ruby/issues/19341)) 
+
 ### 2.7.1 (2023-06-16)
 
 #### Documentation

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

@@ -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.
         #
@@ -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.
         #

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

@@ -457,6 +457,67 @@ module Google
           true
         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 source_instance_id [String] Existing instance ID. Backup will be copied from this instance. Required.
+        # @param source_cluster_id [String] Existing cluster ID. Backup will be copied from this cluster. Required.
+        # @param source_backup_id [Instance, String] Existing backup ID. This backup will be copied. 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 specified backup at a specific location
+        #   require "google/cloud/bigtable"
+        #
+        #   bigtable = Google::Cloud::Bigtable.new
+        #
+        #   job = bigtable.copy_backup dest_project_id:"my-project-2",
+        #                              dest_instance_id:"my-instance-2",
+        #                              dest_cluster_id:"my-cluster-2",
+        #                              new_backup_id:"my-backup-2",
+        #                              source_instance_id:"my-instance",
+        #                              source_cluster_id:"my-cluster",
+        #                              source_backup_id:"my-backup",
+        #                              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_backup dest_project_id:, dest_instance_id:, dest_cluster_id:, new_backup_id:,
+                        source_instance_id:, source_cluster_id:, source_backup_id:, expire_time:
+          ensure_service!
+          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(source_instance_id,
+                                                                        source_cluster_id,
+                                                                        source_backup_id),
+                                     expire_time: expire_time
+          Backup::Job.from_grpc grpc, service
+        end
+
         protected
 
         # @private

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

@@ -725,6 +725,19 @@ module Google
           tables.create_backup parent: cluster_path(instance_id, cluster_id), backup_id: backup_id, backup: backup
         end
 
+        ##
+        # Starts copying the selected backup to the chosen location.
+        # The underlying Google::Longrunning::Operation tracks the copying of backup.
+        #
+        # @return [Gapic::Operation]
+        #
+        def copy_backup project_id:, instance_id:, cluster_id:, backup_id:, source_backup:, expire_time:
+          tables.copy_backup parent: "projects/#{project_id}/instances/#{instance_id}/clusters/#{cluster_id}",
+                             backup_id: backup_id,
+                             source_backup: source_backup,
+                             expire_time: expire_time
+        end
+
         ##
         # @return [Google::Cloud::Bigtable::Admin::V2::Backup]
         #

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-bigtable
 version: !ruby/object:Gem::Version
-  version: 2.7.1
+  version: 2.8.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-16 00:00:00.000000000 Z
+date: 2023-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-bigtable-admin-v2