google-cloud-bigtable 2.4.1 → 2.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d2ceaa917a67e31cae160f8cfb03ecb1617aebf24c634d89a3f5805589d3f46
-  data.tar.gz: c2c614ffbd788256c15037c22ff9f7fd09208399a49ee85149e9515e0976f0f9
+  metadata.gz: 81a641fcf7c94e068213a96b5ebc6c9694cf87367ca83c9672a70a08620fcfae
+  data.tar.gz: 76079a26712e7c3854cd1b21d519948964465154f7f4fcc779700924e1eb3e3d
 SHA512:
-  metadata.gz: 6e019a7ad97017938d2960b52951dda90911d5f84c6d3c95cd09abd0086d35b68f8f4139d5626c92065928eec8493758aa0fb6d6185cf89a149eadde53c54675
-  data.tar.gz: f3eeec0098bd030dad2a8cd07b08dae4d58d02753ead572d552eaf7543a93776ca48576bb7c37199a7cd181f6f23e98f989778a0f7ee8e9e614522f97fbf23e8
+  metadata.gz: 6daa16efede84fa797bd7d7b440e3a0cd36eb886611a73e68d2fb6c488a1db1ac81ddad61f8261fcc7e6fb2111a4bcc5e0f5a3d54004cd75f2c46e8e65aa53da
+  data.tar.gz: 0e86c2513212dde4e9732b4437a89af59d75068e954c52c7b821a2e9527fee8429cb1e4ebec422f33f496fb2bebe7eacbd1a0dc919542deb105cd67948f57315

data/AUTHENTICATION.md

@@ -95,7 +95,8 @@ client = Google::Cloud::Bigtable.new
 
 ### Configuration
 
-The **Project ID** and **Credentials JSON** can be configured instead of placing them in environment variables or providing them as arguments.
+The **Project ID** and the path to the **Credentials JSON** file can be configured
+instead of placing them in environment variables or providing them as arguments.
 
 ```ruby
 require "google/cloud/bigtable"

data/CHANGELOG.md

@@ -1,5 +1,37 @@
 # Release History
 
+### 2.6.2 / 2021-08-02
+
+#### Documentation
+
+* Update inline doc samples to match library code style
+
+### 2.6.1 / 2021-07-08
+
+#### Documentation
+
+* Update AUTHENTICATION.md in handwritten packages
+
+### 2.6.0 / 2021-05-03
+
+#### Features
+
+* Add support for Backup restore to different Instance
+  * Add instance to Backup#restore
+
+### 2.5.0 / 2021-04-20
+
+#### Features
+
+* Add CMEK support
+  * Add kms_key to ClusterMap#add
+  * Add Cluster#kms_key
+  * Add EncryptionInfo
+  * Add ClusterState#encryption_infos
+  * Add ENCRYPTION_VIEW support to Table
+  * Update docs in Table::ClusterState
+  * Add Backup#encryption_info
+
 ### 2.4.1 / 2021-04-01
 
 #### Bug Fixes

data/CONTRIBUTING.md

@@ -119,15 +119,14 @@ If you alter an example's title, you may encounter breaking tests.
 ### Bigtable Acceptance Tests
 
 The Bigtable acceptance tests interact with the live service API. Follow the
-instructions in the {file:AUTHENTICATION.md Authentication guide} for enabling
+instructions in the {file:AUTHENTICATION.md Authentication Guide} for enabling
 the Bigtable API. Occasionally, some API features may not yet be generally
 available, making it difficult for some contributors to successfully run the
 entire acceptance test suite. However, please ensure that you do successfully
 run acceptance tests for any code areas covered by your pull request.
 
 To run the acceptance tests, first create and configure a project in the Google
-Developers Console, as described in the {file:AUTHENTICATION.md Authentication
-guide}. Be sure to download the JSON KEY file. Make note of the PROJECT_ID and
+Developers Console, as described in the {file:AUTHENTICATION.md Authentication Guide}. Be sure to download the JSON KEY file. Make note of the PROJECT_ID and
 the KEYFILE location on your system.
 
 Before you can run the Bigtable acceptance tests, you must first create indexes

data/OVERVIEW.md

@@ -396,5 +396,5 @@ instance.delete
 ## Additional information
 
 Google Bigtable can be configured to use an emulator or to enable gRPC's
-logging. To learn more, see the {file:EMULATOR.md Emulator guide} and
+logging. To learn more, see the {file:EMULATOR.md Emulator guide}} and
 {file:LOGGING.md Logging guide}.

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/app_profile/job.rb

@@ -34,8 +34,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(
@@ -71,8 +71,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(

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

@@ -47,7 +47,7 @@ module Google
           #
           #   bigtable = Google::Cloud::Bigtable.new
           #
-          #   instance = bigtable.instance("my-instance")
+          #   instance = bigtable.instance "my-instance"
           #   app_profiles = instance.app_profiles
           #
           #   if app_profiles.next?
@@ -68,7 +68,7 @@ module Google
           #
           #   bigtable = Google::Cloud::Bigtable.new
           #
-          #   instance = bigtable.instance("my-instance")
+          #   instance = bigtable.instance "my-instance"
           #   app_profiles = instance.app_profiles
           #
           #   if app_profiles.next?
@@ -104,7 +104,7 @@ module Google
           #
           #   bigtable = Google::Cloud::Bigtable.new
           #
-          #   instance = bigtable.instance("my-instance")
+          #   instance = bigtable.instance "my-instance"
           #   app_profiles = instance.app_profiles
           #
           #   instance.app_profiles.all do |app_profile|
@@ -116,11 +116,9 @@ module Google
           #
           #   bigtable = Google::Cloud::Bigtable.new
           #
-          #   instance = bigtable.instance("my-instance")
+          #   instance = bigtable.instance "my-instance"
           #
-          #   all_app_profile_ids = instance.app_profiles.all.map do |app_profile|
-          #     app_profile.name
-          #   end
+          #   all_app_profile_ids = instance.app_profiles.all.map(&:name)
           #
           def all &block
             return enum_for :all unless block_given?

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

@@ -18,10 +18,10 @@
 require "google/cloud/bigtable/backup/job"
 require "google/cloud/bigtable/backup/list"
 require "google/cloud/bigtable/convert"
+require "google/cloud/bigtable/encryption_info"
 require "google/cloud/bigtable/policy"
 require "google/cloud/bigtable/table/restore_job"
 
-
 module Google
   module Cloud
     module Bigtable
@@ -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
@@ -207,6 +207,27 @@ module Google
           state == :READY
         end
 
+        ##
+        # The encryption information for the backup. See also {Instance::ClusterMap#add}.
+        #
+        # @return [Google::Cloud::Bigtable::EncryptionInfo] The encryption information for the backup.
+        #
+        # @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"
+        #
+        #   encryption_info = backup.encryption_info
+        #   encryption_info.encryption_type #=> :GOOGLE_DEFAULT_ENCRYPTION
+        #
+        def encryption_info
+          EncryptionInfo.from_grpc @grpc.encryption_info
+        end
+
         ##
         # Gets the [Cloud IAM](https://cloud.google.com/iam/) access control
         # policy for the backup.
@@ -226,10 +247,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
         #
@@ -237,13 +258,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
@@ -273,14 +294,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
         #
@@ -309,10 +330,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",
@@ -328,9 +349,12 @@ module Google
         end
 
         ##
-        # Creates a new table by restoring from a completed backup.
+        # Creates a new table by restoring data from a completed backup. The new table may be created in an instance
+        # different than that of the backup.
         #
         # @param table_id [String] The table ID for the new table. This table must not yet exist. Required.
+        # @param instance [Instance, String] The instance or the ID of the instance for the new table, if different from
+        #   the instance of the backup. Optional.
         #
         # @return [Google::Cloud::Bigtable::Table::RestoreJob] The job representing the long-running, asynchronous
         #   processing of a backup restore table operation.
@@ -339,12 +363,34 @@ 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"
+        #
+        #   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
+        #
+        # @example Create the table in a different instance.
+        #   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 = cluster.backup "my-backup"
         #
-        #   job = backup.restore("my-new-table")
+        #   table_instance = bigtable.instance "my-other-instance"
+        #   job = backup.restore "my-new-table", instance: table_instance
         #
         #   job.wait_until_done!
         #   job.done? #=> true
@@ -356,8 +402,13 @@ module Google
         #     optimized = job.optimize_table_operation_name
         #   end
         #
-        def restore table_id
-          grpc = service.restore_table table_id, instance_id, cluster_id, backup_id
+        def restore table_id, instance: nil
+          table_instance_id = instance.respond_to?(:instance_id) ? instance.instance_id : instance
+          grpc = service.restore_table table_id,
+                                       instance_id,
+                                       cluster_id,
+                                       backup_id,
+                                       table_instance_id: table_instance_id
           Table::RestoreJob.from_grpc grpc, service
         end
 
@@ -372,10 +423,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
@@ -407,10 +458,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
         #