google-cloud-bigtable 1.2.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a1017ef14a932be04b10c48b91c119092d63cb819e3c64afd774123046ebd1c
-  data.tar.gz: 1e31e516af43d142ac8d3a06a58c9a79c8bd145d0dc242df571ea56c201b01d4
+  metadata.gz: 864b31028834907aa872f0f5aec7a31a682e419c286744c1cc3243072597e739
+  data.tar.gz: 543de2a38416692f95400157b4ca67520b5a6765bed60dd1237b3be405a10d2e
 SHA512:
-  metadata.gz: 9505756672b52a498ecaf695c639d1f4f01308878e6adbddbe7cf8c4ea36f0f0fc6d26fd8f2874112ba1eb462d4d3a8c83f8f1f456f13fc24bf91473739794c7
-  data.tar.gz: 467538a39acc69162f601920f0924e2707473adf27f0c5b9ee9d9fd3c2be79ac48ffc760c1e7288b586428df49d9f80a123b68f675d2b38f68838d7c82534853
+  metadata.gz: a62102b9792b017c396477aa79435a29b1c495e2234c8a34c6040c74883c9aaa7f07cf9e945606a139e7f8d032f57663da235a8a6f3e8922eeaad72f5a582b46
+  data.tar.gz: 5d474fd9b72cb0d2474be964d1c0af670266f577af221d6ae76256c34f935ec239040b824e2eadd7e391ad09fde511406f210f0e007796cea69e163d244827f9

data/AUTHENTICATION.md

@@ -76,7 +76,7 @@ The environment variables that google-cloud-bigtable checks for project ID are:
 1. `BIGTABLE_PROJECT`
 2. `GOOGLE_CLOUD_PROJECT`
 
-The environment variables that google-cloud-bigtable checks for credentials are configured on {Google::Cloud::Bigtable::V2::Credentials}:
+The environment variables that google-cloud-bigtable checks for credentials are configured on {Google::Cloud::Bigtable::Credentials}:
 
 1. `BIGTABLE_CREDENTIALS` - Path to JSON file, or JSON contents
 2. `BIGTABLE_KEYFILE` - Path to JSON file, or JSON contents

data/CHANGELOG.md

@@ -1,5 +1,62 @@
 # Release History
 
+### 2.2.0 / 2020-11-11
+
+#### Features
+
+* Add Backup-level IAM Policy support
+  * Add Backup#policy
+  * Add Backup#update_policy
+  * Add Backup#test_iam_permissions
+
+### 2.1.0 / 2020-09-17
+
+#### Features
+
+* quota_project can be set via library configuration ([#7630](https://www.github.com/googleapis/google-cloud-ruby/issues/7630))
+
+### 2.0.0 / 2020-08-06
+
+This is a major update that removes the "low-level" client interface code, and
+instead adds the new `google-cloud-bigtable-v2` and
+`google-cloud-bigtable-admin-v2` gems as dependencies. The new dependencies
+are rewritten low-level clients, produced by a next-generation client code
+generator, with improved performance and stability.
+
+This change should have no effect on the high-level interface that most users
+will use. The one exception is that the (mostly undocumented) `client_config`
+argument, for adjusting low-level parameters such as RPC retry settings on
+client objects, has been removed. If you need to adjust these parameters, use
+the configuration interface in `google-cloud-bigtable-v2` and
+`google-cloud-bigtable-admin-v2`.
+
+Substantial changes have been made in the low-level interfaces, however. If you
+are using the low-level classes under the `Google::Cloud::Bigtable::V2` or
+`Google::Cloud::Bigtable::Admin::V2` modules, please review the docs for the
+new `google-cloud-bigtable-v2` and `google-cloud-bigtable-admin-v2` gems.
+In particular:
+
+* Some classes have been renamed, notably the client classes themselves.
+* The client constructor takes a configuration block instead of configuration
+  keyword arguments.
+* All RPC method arguments are now keyword arguments.
+
+### 1.3.0 / 2020-07-21
+
+#### Features
+
+* Add Managed Backups
+  * Add Cluster#create_backup, Cluster#backup and Cluster#backups
+  * Add Backup, Backup::Job and Backup::List
+  * Add Table::RestoreJob
+  * Add ClusterState#ready_optimizing?
+
+### 1.2.2 / 2020-05-28
+
+#### Documentation
+
+* Fix a few broken links
+
 ### 1.2.1 / 2020-05-21
 
 #### Bug Fixes

data/TROUBLESHOOTING.md

@@ -24,14 +24,8 @@ improved, *please* create a new issue on GitHub so we can talk about it.
 
   - [New issue][gh-ruby]
 
-Or, you can ask questions on the [Google Cloud Platform Slack][slack-ruby]. You
-can use the "ruby" channel for general Ruby questions, or use the
-"google-cloud-ruby" channel if you have questions about this gem in particular.
-
 [so-ruby]: http://stackoverflow.com/questions/tagged/google-cloud-platform+ruby+bigtable
 
-[gh-search-ruby]: https://github.com/googlecloudplatform/google-cloud-ruby/issues?q=label%3A%22api%3A+bigtable%22
-
-[gh-ruby]: https://github.com/googlecloudplatform/google-cloud-ruby/issues/new
+[gh-search-ruby]: https://github.com/googleapis/google-cloud-ruby/issues?q=label%3A%22api%3A+bigtable%22
 
-[slack-ruby]: https://gcp-slack.appspot.com/
+[gh-ruby]: https://github.com/googleapis/google-cloud-ruby/issues/new

data/lib/google-cloud-bigtable.rb

@@ -55,11 +55,6 @@ module Google
     #   should already be composed with a `GRPC::Core::CallCredentials` object.
     #   `Proc` will be used as an updater_proc for the gRPC channel. The proc transforms the
     #   metadata for requests, generally, to give OAuth credentials.
-    # @param client_config [Hash]
-    #   A hash for call options for each method.
-    #   See Google::Gax#construct_settings for the structure of
-    #   this data. Falls back to the default config if not specified
-    #   or the specified config is missing data points.
     # @return [Google::Cloud::Bigtable::Project]
     #
     # @example
@@ -69,13 +64,12 @@ module Google
     #
     #   bigtable = gcloud.bigtable
     #
-    def bigtable scope: nil, timeout: nil, credentials: nil, client_config: nil
+    def bigtable scope: nil, timeout: nil, credentials: nil
       Google::Cloud.bigtable(
-        project_id:    @project,
-        credentials:   (credentials || @keyfile),
-        scope:         scope,
-        timeout:       (timeout || @timeout),
-        client_config: client_config
+        project_id:  @project,
+        credentials: (credentials || @keyfile),
+        scope:       scope,
+        timeout:     (timeout || @timeout)
       )
     end
 
@@ -110,11 +104,6 @@ module Google
     #   updater_proc is supplied.
     # @param timeout [Integer]
     #   The default timeout, in seconds, for calls made through this client.
-    # @param client_config [Hash]
-    #   A hash for call options for each method.
-    #   See Google::Gax#construct_settings for the structure of
-    #   this data. Falls back to the default config if not specified
-    #   or the specified config is missing data points. Optional.
     # @return [Google::Cloud::Bigtable::Project]
     #
     # @example
@@ -122,14 +111,13 @@ module Google
     #
     #   bigtable = Google::Cloud.bigtable
     #
-    def self.bigtable project_id: nil, credentials: nil, scope: nil, timeout: nil, client_config: nil
+    def self.bigtable project_id: nil, credentials: nil, scope: nil, timeout: nil
       require "google/cloud/bigtable"
       Google::Cloud::Bigtable.new(
-        project_id:    project_id,
-        credentials:   credentials,
-        scope:         scope,
-        timeout:       timeout,
-        client_config: client_config
+        project_id:  project_id,
+        credentials: credentials,
+        scope:       scope,
+        timeout:     timeout
       )
     end
   end
@@ -149,6 +137,21 @@ Google::Cloud.configure.add_config! :bigtable do |config|
   default_emulator = Google::Cloud::Config.deferred do
     ENV["BIGTABLE_EMULATOR_HOST"]
   end
+  default_scopes = [
+    "https://www.googleapis.com/auth/bigtable.admin",
+    "https://www.googleapis.com/auth/bigtable.admin.cluster",
+    "https://www.googleapis.com/auth/bigtable.admin.instance",
+    "https://www.googleapis.com/auth/bigtable.admin.table",
+    "https://www.googleapis.com/auth/bigtable.data",
+    "https://www.googleapis.com/auth/bigtable.data.readonly",
+    "https://www.googleapis.com/auth/cloud-bigtable.admin",
+    "https://www.googleapis.com/auth/cloud-bigtable.admin.cluster",
+    "https://www.googleapis.com/auth/cloud-bigtable.admin.table",
+    "https://www.googleapis.com/auth/cloud-bigtable.data",
+    "https://www.googleapis.com/auth/cloud-bigtable.data.readonly",
+    "https://www.googleapis.com/auth/cloud-platform",
+    "https://www.googleapis.com/auth/cloud-platform.read-only"
+  ]
 
   config.add_field! :project_id, default_project, match: String, allow_nil: true
   config.add_alias! :project, :project_id
@@ -162,10 +165,10 @@ Google::Cloud.configure.add_config! :bigtable do |config|
                       Proc
                     ],
                     allow_nil: true
-  config.add_field! :scope, nil, match: [String, Array]
+  config.add_field! :scope, default_scopes, match: [String, Array]
+  config.add_field! :quota_project, nil, match: String
   config.add_field! :timeout, nil, match: Integer
-  config.add_field! :client_config, nil, match: Hash
-  config.add_field! :emulator_host, default_emulator,
-                    match: String, allow_nil: true
-  config.add_field! :endpoint, nil, match: String
+  config.add_field! :emulator_host, default_emulator, match: String, allow_nil: true
+  config.add_field! :endpoint, "bigtable.googleapis.com", match: String
+  config.add_field! :endpoint_admin, "bigtableadmin.googleapis.com", match: String
 end

data/lib/google/cloud/bigtable.rb

@@ -51,6 +51,8 @@ module Google
       #   metadata for requests, generally, to give OAuth credentials.
       # @param [String] endpoint Override of the endpoint host name. Optional.
       #   If the param is nil, uses the default endpoint.
+      # @param [String] endpoint_admin Override of the admin service endpoint host name. Optional.
+      #   If the param is nil, uses the default admin endpoint.
       # @param [String] emulator_host Bigtable emulator host. Optional.
       #   If the parameter is nil, uses the value of the `emulator_host` config.
       # @param scope [Array<String>]
@@ -59,11 +61,6 @@ module Google
       #   APIs](https://developers.google.com/identity/protocols/OAuth2).
       #   The OAuth scopes for this service. This parameter is ignored if an
       #   updater_proc is supplied.
-      # @param client_config [Hash]
-      #   A hash for call options for each method.
-      #   See Google::Gax#construct_settings for the structure of
-      #   this data. Falls back to the default config if not specified
-      #   or the specified config is missing data points.
       # @param timeout [Integer]
       #   The default timeout, in seconds, for calls made through this client. Optional.
       # @return [Google::Cloud::Bigtable::Project]
@@ -73,28 +70,28 @@ module Google
       #
       #   client = Google::Cloud::Bigtable.new
       #
-      def self.new project_id: nil, credentials: nil, emulator_host: nil, scope: nil, client_config: nil, endpoint: nil,
+      def self.new project_id: nil,
+                   credentials: nil,
+                   emulator_host: nil,
+                   scope: nil,
+                   endpoint: nil,
+                   endpoint_admin: nil,
                    timeout: nil
         project_id    ||= default_project_id
         scope         ||= configure.scope
         timeout       ||= configure.timeout
-        client_config ||= configure.client_config
         emulator_host ||= configure.emulator_host
         endpoint      ||= configure.endpoint
+        endpoint_admin ||= configure.endpoint_admin
 
-        if emulator_host
-          return new_with_emulator project_id, emulator_host, timeout,
-                                   client_config
-        end
+        return new_with_emulator project_id, emulator_host, timeout if emulator_host
 
         credentials = resolve_credentials credentials, scope
         project_id = resolve_project_id project_id, credentials
         raise ArgumentError, "project_id is missing" if project_id.empty?
 
-        service = Bigtable::Service.new(
-          project_id, credentials,
-          host: endpoint, timeout: timeout, client_config: client_config
-        )
+        service = Bigtable::Service.new \
+          project_id, credentials, host: endpoint, host_admin: endpoint_admin, timeout: timeout
         Bigtable::Project.new service
       end
 
@@ -113,10 +110,10 @@ module Google
       # * `scope` - (String, Array<String>) The OAuth 2.0 scopes controlling
       #   the set of resources and operations that the connection can access.
       # * `timeout` - (Integer) Default timeout to use in requests.
-      # * `client_config` - (Hash) A hash of values to override the default
-      #   behavior of the API client.
       # * `endpoint` - (String) Override of the endpoint host name, or `nil`
       #   to use the default endpoint.
+      # * `endpoint_admin` - (String) Override of the admin service endpoint
+      #   host name, or `nil` to use the default admin endpoint.
       #
       # @return [Google::Cloud::Config] The configuration object the
       #   Google::Cloud::Bigtable library uses.
@@ -130,18 +127,13 @@ module Google
       # @private
       # New client given an emulator host.
       #
-      def self.new_with_emulator project_id, emulator_host, timeout,
-                                 client_config
+      def self.new_with_emulator project_id, emulator_host, timeout
         project_id = project_id.to_s # Always cast to a string
         raise ArgumentError, "project_id is missing" if project_id.empty?
 
-        Bigtable::Project.new(
-          Bigtable::Service.new(
-            project_id, :this_channel_is_insecure,
-            host: emulator_host, timeout: timeout,
-            client_config: client_config
-          )
-        )
+        service = Bigtable::Service.new \
+          project_id, :this_channel_is_insecure, host: emulator_host, host_admin: emulator_host, timeout: timeout
+        Bigtable::Project.new service
       end
 
       # @private

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

@@ -193,7 +193,7 @@ module Google
         #
         def routing_policy= policy
           routing_policy_grpc = policy.to_grpc
-          if routing_policy_grpc.is_a? Google::Bigtable::Admin::V2::AppProfile::SingleClusterRouting
+          if routing_policy_grpc.is_a? Google::Cloud::Bigtable::Admin::V2::AppProfile::SingleClusterRouting
             @grpc.single_cluster_routing = routing_policy_grpc
             @changed_fields["routing_policy"] = "single_cluster_routing"
           else
@@ -417,8 +417,8 @@ module Google
         # @private
         #
         # Creates a new Instance instance from a
-        # Google::Bigtable::Admin::V2::Table.
-        # @param grpc [Google::Bigtable::Admin::V2::Table]
+        # Google::Cloud::Bigtable::Admin::V2::Table.
+        # @param grpc [Google::Cloud::Bigtable::Admin::V2::Table]
         # @param service [Google::Cloud::Bigtable::Service]
         # @return [Google::Cloud::Bigtable::Table]
         def self.from_grpc grpc, service

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
           #
@@ -135,8 +135,10 @@ module Google
           end
 
           # @private
-          # New Snapshot::List from a Google::Gax::PagedEnumerable<Google::Bigtable::Admin::V2::AppProfile> object.
-          # @param grpc [Google::Gax::PagedEnumerable<Google::Bigtable::Admin::V2::AppProfile> ]
+          # New Snapshot::List from a Gapic::PagedEnumerable<Google::Cloud::Bigtable::Admin::V2::AppProfile>
+          # object.
+          #
+          # @param grpc [Gapic::PagedEnumerable<Google::Cloud::Bigtable::Admin::V2::AppProfile> ]
           # @param service [Google::Cloud::Bigtable::Service]
           # @return [Array<Google::Cloud::Bigtable::AppProfile>]
           def self.from_grpc grpc, service

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

@@ -0,0 +1,445 @@
+# 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/policy"
+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
+
+        ##
+        # Gets the [Cloud IAM](https://cloud.google.com/iam/) access control
+        # policy for the backup.
+        #
+        # @see https://cloud.google.com/bigtable/docs/access-control
+        #
+        # @yield [policy] A block for updating the policy. The latest policy
+        #   will be read from the Bigtable service and passed to the block. After
+        #   the block completes, the modified policy will be written to the
+        #   service.
+        # @yieldparam [Policy] policy the current Cloud IAM Policy for this
+        #   backup.
+        #
+        # @return [Policy] The current Cloud IAM Policy 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")
+        #
+        #   policy = backup.policy
+        #
+        # @example Update the policy by passing a block.
+        #   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.policy do |p|
+        #     p.add("roles/owner", "user:owner@example.com")
+        #   end # 2 API calls
+        #
+        def policy
+          ensure_service!
+          grpc = service.get_backup_policy instance_id, cluster_id, backup_id
+          policy = Policy.from_grpc grpc
+          return policy unless block_given?
+          yield policy
+          update_policy policy
+        end
+
+        ##
+        # Updates the [Cloud IAM](https://cloud.google.com/iam/) access control
+        # policy for the backup. The policy should be read from {#policy}.
+        # See {Google::Cloud::Bigtable::Policy} for an explanation of the policy
+        # `etag` property and how to modify policies.
+        #
+        # You can also update the policy by passing a block to {#policy}, which
+        # will call this method internally after the block completes.
+        #
+        # @param new_policy [Policy] a new or modified Cloud IAM Policy for this
+        #   backup
+        #
+        # @return [Policy] The policy returned by the API update 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")
+        #
+        #   policy = backup.policy
+        #   policy.add("roles/owner", "user:owner@example.com")
+        #   updated_policy = backup.update_policy(policy)
+        #
+        #   puts updated_policy.roles
+        #
+        def update_policy new_policy
+          ensure_service!
+          grpc = service.set_backup_policy instance_id, cluster_id, backup_id, new_policy.to_grpc
+          Policy.from_grpc grpc
+        end
+        alias policy= update_policy
+
+        ##
+        # Tests the specified permissions against the [Cloud
+        # IAM](https://cloud.google.com/iam/) access control policy.
+        #
+        # @see https://cloud.google.com/iam/docs/managing-policies Managing Policies
+        # @see https://cloud.google.com/bigtable/docs/access-control Access Control
+        #
+        # @param permissions [String, Array<String>] permissions The set of permissions to
+        #   check access for. Permissions with wildcards (such as `*` or `bigtable.*`) are
+        #   not allowed.
+        #   See [Access Control](https://cloud.google.com/bigtable/docs/access-control).
+        #
+        # @return [Array<String>] The permissions that are configured for the policy.
+        #
+        # @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")
+        #
+        #   permissions = backup.test_iam_permissions(
+        #     "bigtable.backups.delete",
+        #     "bigtable.backups.get"
+        #   )
+        #   permissions.include? "bigtable.backups.delete" #=> false
+        #   permissions.include? "bigtable.backups.get" #=> true
+        #
+        def test_iam_permissions *permissions
+          ensure_service!
+          grpc = service.test_backup_permissions instance_id, cluster_id, backup_id, permissions.flatten
+          grpc.permissions.to_a
+        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::Cloud::Bigtable::Admin::V2::Backup.
+        #
+        # @param grpc [Google::Cloud::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