google-cloud-bigtable 2.7.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec6f4d74dfa766b50aad6316df5d1a573ce463c692a165f7a5b187ba8f7cff57
-  data.tar.gz: 725ec7db3d5a85a4071b4914393917381a9a2fc603826700c0ebd00f5962b3a8
+  metadata.gz: 735e0a2c4fcb24227bbdf5e7f1ee76d6e8f718b6d23cf30bdf56fd8c6f13f830
+  data.tar.gz: fd7c5cb8fa45cd44a7e0a39c78a88bf63e52214c133505dbfbc2977a86b89cd0
 SHA512:
-  metadata.gz: 2f4f3d6b8c14de86c5b6c63187d652ad351d59409507e0c35abe99cfa52a9e0ce83ee57ed8be17c102f18576464a4b09ee4eb15ab076743286f57aa99f603315
-  data.tar.gz: 8c33973c6872a227da6b1342e88738072485968df25160d9ad3fa1c5029d5a31cf03ee02ba612bae4c66b0d5665fd2f209940222be931392f4cee6ede2803780
+  metadata.gz: 2ee38cb00b572386d02f7b7f4f7abd593b0d8022e4dd366a54b2789bf8f4e8ee04b73a9ece3286707a81ce68006fb8f2f84685a721057c16b607911e4d8da5e2
+  data.tar.gz: a9686ba49ac1a4761761570f0486edcbb6d628eaaa5c8183df65b6f697c9f50022abf8b61f7420f6b79b5f7e00ad4b9a99f1f0f45266ca248fc47ae8e874ec5a

data/AUTHENTICATION.md

@@ -124,15 +124,6 @@ To configure your system for this, simply:
 **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
 *should* only be used during development.
 
-[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
-[dev-console]: https://console.cloud.google.com/project
-
-[enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
-
-[create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
-[create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
-[reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
-
 ## Creating a Service Account
 
 Google Cloud requires a **Project ID** and **Service Account Credentials** to
@@ -143,31 +134,22 @@ If you are not running this client within [Google Cloud Platform
 environments](#google-cloud-platform-environments), you need a Google
 Developers service account.
 
-1. Visit the [Google Developers Console][dev-console].
+1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
 1. Create a new project or click on an existing project.
-1. Activate the slide-out navigation tray and select **API Manager**. From
+1. Activate the menu in the upper left and select **APIs & Services**. From
    here, you will enable the APIs that your application requires.
 
-   ![Enable the APIs that your application requires][enable-apis]
-
    *Note: You may need to enable billing in order to use these services.*
 
 1. Select **Credentials** from the side navigation.
 
-   You should see a screen like one of the following.
-
-   ![Create a new service account][create-new-service-account]
-
-   ![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
-
-   Find the "Add credentials" drop down and select "Service account" to be
-   guided through downloading a new JSON key file.
-
-   If you want to re-use an existing service account, you can easily generate a
-   new key file. Just select the account you wish to re-use, and click "Generate
-   new JSON key":
+   Find the "Create credentials" drop down near the top of the page, and select
+   "Service account" to be guided through downloading a new JSON key file.
 
-   ![Re-use an existing service account][reuse-service-account]
+   If you want to re-use an existing service account, you can easily generate 
+   a new key file. Just select the account you wish to re-use click the pencil
+   tool on the right side to edit the service account, select the **Keys** tab,
+   and then select **Add Key**.
 
    The key file you download will be used by this library to authenticate API
    requests and should be stored in a secure location.

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # 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
+
+* Fixed broken links in authentication documentation ([#21619](https://github.com/googleapis/google-cloud-ruby/issues/21619)) 
+
 ### 2.7.0 (2022-07-01)
 
 #### Features

data/LOGGING.md

@@ -3,7 +3,7 @@
 To enable logging for this library, set the logger for the underlying
 [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library. The logger
 that you set may be a Ruby stdlib
-[`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as
+[`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as
 shown below, or a
 [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
 that will write logs to [Stackdriver

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/instance/cluster_map.rb

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

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

@@ -429,7 +429,7 @@ module Google
             serve_nodes:          nodes,
             default_storage_type: storage_type,
             location:             location
-          }.delete_if { |_, v| v.nil? }
+          }.compact
 
           cluster = Google::Cloud::Bigtable::Admin::V2::Cluster.new attrs
           grpc = service.create_cluster instance_id, cluster_id, cluster
@@ -721,7 +721,7 @@ module Google
             single_cluster_routing:        single_cluster_routing,
             description:                   description,
             etag:                          etag
-          }.delete_if { |_, v| v.nil? }
+          }.compact
 
           grpc = service.create_app_profile(
             instance_id,

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

@@ -226,7 +226,7 @@ module Google
         def create_instance instance_id, display_name: nil, type: nil, labels: nil, clusters: nil
           labels = labels.to_h { |k, v| [String(k), String(v)] } if labels
 
-          instance_attrs = { display_name: display_name, type: type, labels: labels }.delete_if { |_, v| v.nil? }
+          instance_attrs = { display_name: display_name, type: type, labels: labels }.compact
           instance = Google::Cloud::Bigtable::Admin::V2::Instance.new instance_attrs
           clusters ||= Instance::ClusterMap.new
           yield clusters if block_given?
@@ -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

@@ -282,12 +282,12 @@ module Google
           initial_splits = initial_splits.map { |key| { key: key } } if initial_splits
 
           tables.create_table(
-            {
+            **{
               parent:         instance_path(instance_id),
               table_id:       table_id,
               table:          table,
               initial_splits: initial_splits
-            }.delete_if { |_, v| v.nil? }
+            }.compact
           )
         end
 
@@ -650,7 +650,7 @@ module Google
 
         def read_rows instance_id, table_id, app_profile_id: nil, rows: nil, filter: nil, rows_limit: nil
           client.read_rows(
-            {
+            **{
               table_name:     table_path(instance_id, table_id),
               rows:           rows,
               filter:         filter,
@@ -666,22 +666,22 @@ module Google
 
         def mutate_row table_name, row_key, mutations, app_profile_id: nil
           client.mutate_row(
-            {
+            **{
               table_name:     table_name,
               app_profile_id: app_profile_id,
               row_key:        row_key,
               mutations:      mutations
-            }.delete_if { |_, v| v.nil? }
+            }.compact
           )
         end
 
         def mutate_rows table_name, entries, app_profile_id: nil
           client.mutate_rows(
-            {
+            **{
               table_name:     table_name,
               app_profile_id: app_profile_id,
               entries:        entries
-            }.delete_if { |_, v| v.nil? }
+            }.compact
           )
         end
 
@@ -692,25 +692,25 @@ module Google
                                  true_mutations: nil,
                                  false_mutations: nil
           client.check_and_mutate_row(
-            {
+            **{
               table_name:       table_name,
               app_profile_id:   app_profile_id,
               row_key:          row_key,
               predicate_filter: predicate_filter,
               true_mutations:   true_mutations,
               false_mutations:  false_mutations
-            }.delete_if { |_, v| v.nil? }
+            }.compact
           )
         end
 
         def read_modify_write_row table_name, row_key, rules, app_profile_id: nil
           client.read_modify_write_row(
-            {
+            **{
               table_name:     table_name,
               app_profile_id: app_profile_id,
               row_key:        row_key,
               rules:          rules
-            }.delete_if { |_, v| v.nil? }
+            }.compact
           )
         end
 
@@ -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/table.rb

@@ -470,7 +470,7 @@ module Google
           table = Google::Cloud::Bigtable::Admin::V2::Table.new({
             column_families: column_families.to_grpc_hash,
             granularity:     granularity
-          }.delete_if { |_, v| v.nil? })
+          }.compact)
 
           grpc = service.create_table instance_id, table_id, table, initial_splits: initial_splits
           from_grpc grpc, service, view: :SCHEMA_VIEW

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Bigtable
-      VERSION = "2.7.0".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.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-01 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
@@ -249,7 +249,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.14
+rubygems_version: 3.4.2
 signing_key: 
 specification_version: 4
 summary: API Client library for Cloud Bigtable API