google-cloud-bigtable 1.3.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 109fb6841cdecd45ebfadc3c2bafd019010847bbe9592ad9f2d9d44e56000d06
-  data.tar.gz: 41b10cd762bc1c11ef42754af3fb6dc3e9bc5d97bd75e84c74752228596bb245
+  metadata.gz: ceb71908240117b3c3e98f009a6be24f4ae9ca510523414b91720aab576f925a
+  data.tar.gz: 15c5a7c7617184eac62271c0ba4b2de71b4f9d643c25751dcef0de98dde7d67c
 SHA512:
-  metadata.gz: 63fda26d33b5b2185086377ecf4ca64d99d20e19013b97b7a34a11164baefbc2e09e444e4304a22a4ac5da49013bb09803e0d81b55bcd3ac8f94f712e320043d
-  data.tar.gz: ec6d0a4356a0fb357264bd72654cfb21581c9787e5594e016e81d286345ef25ad6b8b8eb450dd26de061e5ca0ee32bf337fb43beb0847197d039b4007f74b5f0
+  metadata.gz: 00155edefe171f720de9af636a6a8be2844f889c1750af57a851de83c567e6fc746ce1dbf2f05515d73f0424acade2566874d096f867af1b8c1f5b99e132e81c
+  data.tar.gz: e8a2f9731e9d43897c213ace6810f3a4dcc86a9f5d71eefcf802143c34ca6a151b23e2649081779932c03244e4f3c1ca182f214f122e82b76cbc3a0404d3e54f

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,59 @@
 # Release History
 
+### 2.3.0 / 2021-02-04
+
+#### Features
+
+* Add integer support to RowFilter#value and ValueRange
+  * Encode Integer arguments as 64-bit signed big-endian integer data
+
+### 2.2.1 / 2021-01-13
+
+#### Documentation
+
+* Use consistent column family and field names in samples
+
+### 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

data/CONTRIBUTING.md

@@ -45,7 +45,7 @@ there is a small amount of setup:
 
    ```sh
    $ cd google-cloud-bigtable/
-   $ bundle exec rake bundleupdate
+   $ bundle install
    ```
 
 ## Console

data/OVERVIEW.md

@@ -194,8 +194,8 @@ table = bigtable.table("my-instance", "my-table")
 
 entry = table.new_mutation_entry("user-1")
 entry.set_cell(
-  "cf-1",
-  "field-1",
+  "cf1",
+  "field1",
   "XYZ",
   timestamp: (Time.now.to_f * 1000000).round(-3) # microseconds
 ).delete_cells("cf2", "field02")
@@ -245,8 +245,8 @@ table = bigtable.table("my-instance", "my-table")
 predicate_filter = Google::Cloud::Bigtable::RowFilter.key("user-10")
 on_match_mutations = Google::Cloud::Bigtable::MutationEntry.new
 on_match_mutations.set_cell(
-  "cf-1",
-  "field-1",
+  "cf1",
+  "field1",
   "XYZ",
   timestamp: (Time.now.to_f * 1000000).round(-3) # microseconds
 ).delete_cells("cf2", "field02")

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

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

@@ -18,6 +18,7 @@
 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"
 
 
@@ -206,6 +207,126 @@ module Google
           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.
         #
@@ -301,9 +422,9 @@ module Google
 
         # @private
         #
-        # Creates a new Backup instance from a Google::Bigtable::Admin::V2::Backup.
+        # Creates a new Backup instance from a Google::Cloud::Bigtable::Admin::V2::Backup.
         #
-        # @param grpc [Google::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