google-cloud-bigtable 0.6.2 → 1.0.2

data/lib/google-cloud-bigtable.rb

@@ -26,6 +26,7 @@ require "google/cloud/config"
 
 module Google
   module Cloud
+    ##
     # Creates a new object for connecting to the Cloud Bigtable service.
     #
     # For more information on connecting to Google Cloud Platform, see the
@@ -39,7 +40,8 @@ module Google
     #   updater_proc is supplied.
     # @param timeout [Integer]
     #   The default timeout, in seconds, for calls made through this client.
-    # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
+    # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel,
+    #   GRPC::Core::ChannelCredentials, Proc]
     #   Provides the means for authenticating requests made by the client. This parameter can
     #   be one of the following types.
     #   `Google::Auth::Credentials` uses the properties of its represented keyfile for
@@ -61,23 +63,23 @@ module Google
     # @return [Google::Cloud::Bigtable::Project]
     #
     # @example
-    #   require "google/cloud"
+    #   require "google/cloud/bigtable"
     #
     #   gcloud  = Google::Cloud.new
     #
     #   bigtable = gcloud.bigtable
     #
-
     def bigtable scope: nil, timeout: nil, credentials: nil, client_config: nil
       Google::Cloud.bigtable(
-        project_id: @project,
-        credentials: (credentials || @keyfile),
-        scope: scope,
-        timeout: (timeout || @timeout),
+        project_id:    @project,
+        credentials:   (credentials || @keyfile),
+        scope:         scope,
+        timeout:       (timeout || @timeout),
         client_config: client_config
       )
     end
 
+    ##
     # Creates a Cloud Bigtable client instance for data, table admin and instance admin
     # operations.
     #
@@ -85,7 +87,8 @@ module Google
     #   Project identifier for the Bigtable service you
     #   are connecting to. If not present, the default project for the
     #   credentials is used.
-    # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
+    # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel,
+    #   GRPC::Core::ChannelCredentials, Proc]
     #   The means for authenticating requests made by the client. This parameter can
     #   be one of the following types.
     #   `Google::Auth::Credentials` uses the properties of its represented keyfile for
@@ -99,7 +102,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 timeout [Integer]
     # @param scope [Array<String>]
     #   The OAuth 2.0 scopes controlling the set of resources and operations
     #   that the connection can access. See [Using OAuth 2.0 to Access Google
@@ -116,22 +118,17 @@ module Google
     # @return [Google::Cloud::Bigtable::Project]
     #
     # @example
-    #   require "google/cloud"
+    #   require "google/cloud/bigtable"
     #
     #   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, client_config: nil
       require "google/cloud/bigtable"
       Google::Cloud::Bigtable.new(
-        project_id: project_id,
-        credentials: credentials,
-        scope: scope,
-        timeout: timeout,
+        project_id:    project_id,
+        credentials:   credentials,
+        scope:         scope,
+        timeout:       timeout,
         client_config: client_config
       )
     end
@@ -156,7 +153,7 @@ Google::Cloud.configure.add_config! :bigtable do |config|
   config.add_field! :project_id, default_project, match: String, allow_nil: true
   config.add_alias! :project, :project_id
   config.add_field! :credentials, default_creds,
-                    match: [
+                    match:     [
                       String,
                       Hash,
                       Google::Auth::Credentials,

data/lib/google/bigtable/admin/v2/bigtable_table_admin_services_pb.rb

@@ -109,7 +109,7 @@ module Google
             # recommended for production use. It is not subject to any SLA or deprecation
             # policy.
             rpc :DeleteSnapshot, DeleteSnapshotRequest, Google::Protobuf::Empty
-            # Gets the access control policy for an instance resource. Returns an empty
+            # Gets the access control policy for a table resource. Returns an empty
             # policy if an table exists but does not have a policy set.
             rpc :GetIamPolicy, Google::Iam::V1::GetIamPolicyRequest, Google::Iam::V1::Policy
             # Sets the access control policy on a table resource. Replaces any existing

data/lib/google/bigtable/v2/bigtable_pb.rb

@@ -5,6 +5,9 @@
 require 'google/protobuf'
 
 require 'google/api/annotations_pb'
+require 'google/api/client_pb'
+require 'google/api/field_behavior_pb'
+require 'google/api/resource_pb'
 require 'google/bigtable/v2/data_pb'
 require 'google/protobuf/wrappers_pb'
 require 'google/rpc/status_pb'

data/lib/google/bigtable/v2/bigtable_services_pb.rb

@@ -1,7 +1,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # Source: google/bigtable/v2/bigtable.proto for package 'google.bigtable.v2'
 # Original file comments:
-# Copyright 2018 Google Inc.
+# Copyright 2019 Google LLC.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/bigtable.rb

@@ -21,18 +21,21 @@ require "google/cloud/bigtable/project"
 
 module Google
   module Cloud
+    ##
     # Cloud Bigtable
     #
     # See {file:OVERVIEW.md Bigtable Overview}.
     #
     module Bigtable
+      ##
       # Service for managing Cloud Bigtable instances and tables and for reading from and
       # writing to Bigtable tables.
       #
       # @param project_id [String]
       #   Project identifier for the Bigtable service you are connecting to.
       #   If not present, the default project for the credentials is used.
-      # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
+      # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel,
+      #   GRPC::Core::ChannelCredentials, Proc]
       #   Provides the means for authenticating requests made by the client. This parameter can
       #   be one of the following types:
       #   `Google::Auth::Credentials` uses the properties of its represented keyfile for
@@ -70,14 +73,8 @@ 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,
-          timeout: nil
+      def self.new project_id: nil, credentials: nil, emulator_host: nil, scope: nil, client_config: nil, endpoint: nil,
+                   timeout: nil
         project_id    ||= default_project_id
         scope         ||= configure.scope
         timeout       ||= configure.timeout
@@ -98,9 +95,10 @@ module Google
           project_id, credentials,
           host: endpoint, timeout: timeout, client_config: client_config
         )
-        Bigtable::Project.new(service)
+        Bigtable::Project.new service
       end
 
+      ##
       # Configure the Google Cloud Bigtable library.
       #
       # The following Bigtable configuration parameters are supported:
@@ -151,10 +149,8 @@ module Google
       #
       def self.resolve_credentials given_credentials, scope
         credentials = given_credentials || default_credentials(scope: scope)
-        unless credentials.is_a? Google::Auth::Credentials
-          credentials = Bigtable::Credentials.new credentials, scope: scope
-        end
-        credentials
+        return credentials if credentials.is_a? Google::Auth::Credentials
+        Bigtable::Credentials.new credentials, scope: scope
       end
 
       # @private
@@ -162,9 +158,7 @@ module Google
       #
       def self.resolve_project_id given_project_id, credentials
         project_id = given_project_id || default_project_id
-        if credentials.respond_to? :project_id
-          project_id ||= credentials.project_id
-        end
+        project_id ||= credentials.project_id if credentials.respond_to? :project_id
         project_id.to_s # Always cast to a string
       end
 

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

@@ -1,4 +1,4 @@
-# Copyright 2019 Google LLC
+# 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.
@@ -22,7 +22,7 @@ module Google
       # rubocop:disable LineLength
 
       ##
-      # # Ruby Client for Cloud Bigtable Admin API ([Beta](https://github.com/googleapis/google-cloud-ruby#versioning))
+      # # Ruby Client for Cloud Bigtable Admin API ([GA](https://github.com/googleapis/google-cloud-ruby#versioning))
       #
       # [Cloud Bigtable Admin API][Product Documentation]:
       #

data/lib/google/cloud/bigtable/admin/v2.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Google LLC
+# 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.
@@ -25,7 +25,7 @@ module Google
         # rubocop:disable LineLength
 
         ##
-        # # Ruby Client for Cloud Bigtable Admin API ([Beta](https://github.com/googleapis/google-cloud-ruby#versioning))
+        # # Ruby Client for Cloud Bigtable Admin API ([GA](https://github.com/googleapis/google-cloud-ruby#versioning))
         #
         # [Cloud Bigtable Admin API][Product Documentation]:
         #

data/lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Google LLC
+# 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.

data/lib/google/cloud/bigtable/admin/v2/bigtable_table_admin_client.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Google LLC
+# 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.
@@ -870,7 +870,7 @@ module Google
               @check_consistency.call(req, options, &block)
             end
 
-            # Gets the access control policy for an instance resource. Returns an empty
+            # Gets the access control policy for a table resource. Returns an empty
             # policy if an table exists but does not have a policy set.
             #
             # @param resource [String]

data/lib/google/cloud/bigtable/admin/v2/credentials.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Google LLC
+# 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.

data/lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/bigtable_instance_admin.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Google LLC
+# 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.

data/lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/bigtable_table_admin.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Google LLC
+# 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.

data/lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/instance.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Google LLC
+# 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.

data/lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/table.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Google LLC
+# 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.

data/lib/google/cloud/bigtable/admin/v2/doc/google/iam/v1/iam_policy.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Google LLC
+# 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.

data/lib/google/cloud/bigtable/admin/v2/doc/google/iam/v1/options.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Google LLC
+# 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.

data/lib/google/cloud/bigtable/admin/v2/doc/google/iam/v1/policy.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Google LLC
+# 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.
@@ -82,12 +82,13 @@ module Google
       #
       #     Operations affecting conditional bindings must specify version 3. This can
       #     be either setting a conditional policy, modifying a conditional binding,
-      #     or removing a conditional binding from the stored conditional policy.
+      #     or removing a binding (conditional or unconditional) from the stored
+      #     conditional policy.
       #     Operations on non-conditional policies may specify any valid value or
       #     leave the field unset.
       #
-      #     If no etag is provided in the call to `setIamPolicy`, any version
-      #     compliance checks on the incoming and/or stored policy is skipped.
+      #     If no etag is provided in the call to `setIamPolicy`, version compliance
+      #     checks against the stored policy is skipped.
       # @!attribute [rw] bindings
       #   @return [Array<Google::Iam::V1::Binding>]
       #     Associates a list of `members` to a `role`. Optionally may specify a
@@ -105,8 +106,8 @@ module Google
       #
       #     If no `etag` is provided in the call to `setIamPolicy`, then the existing
       #     policy is overwritten. Due to blind-set semantics of an etag-less policy,
-      #     'setIamPolicy' will not fail even if either of incoming or stored policy
-      #     does not meet the version requirements.
+      #     'setIamPolicy' will not fail even if the incoming policy version does not
+      #     meet the requirements for modifying the stored policy.
       class Policy; end
 
       # Associates `members` with a `role`.

data/lib/google/cloud/bigtable/admin/v2/doc/google/longrunning/operations.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Google LLC
+# 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.
@@ -21,7 +21,7 @@ module Google
     #   @return [String]
     #     The server-assigned name, which is only unique within the same service that
     #     originally returns it. If you use the default HTTP mapping, the
-    #     `name` should have the format of `operations/some/unique/name`.
+    #     `name` should be a resource name ending with `operations/{unique_id}`.
     # @!attribute [rw] metadata
     #   @return [Google::Protobuf::Any]
     #     Service-specific metadata associated with the operation.  It typically

data/lib/google/cloud/bigtable/admin/v2/doc/google/protobuf/any.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Google LLC
+# 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.

data/lib/google/cloud/bigtable/admin/v2/doc/google/protobuf/duration.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Google LLC
+# 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.

data/lib/google/cloud/bigtable/admin/v2/doc/google/protobuf/empty.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Google LLC
+# 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.

data/lib/google/cloud/bigtable/admin/v2/doc/google/protobuf/field_mask.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Google LLC
+# 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.

data/lib/google/cloud/bigtable/admin/v2/doc/google/protobuf/timestamp.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Google LLC
+# 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.

data/lib/google/cloud/bigtable/admin/v2/doc/google/rpc/status.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Google LLC
+# 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.
@@ -17,67 +17,19 @@ module Google
   module Rpc
     # The `Status` type defines a logical error model that is suitable for
     # different programming environments, including REST APIs and RPC APIs. It is
-    # used by [gRPC](https://github.com/grpc). The error model is designed to be:
+    # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+    # three pieces of data: error code, error message, and error details.
     #
-    # * Simple to use and understand for most users
-    # * Flexible enough to meet unexpected needs
-    #
-    # = Overview
-    #
-    # The `Status` message contains three pieces of data: error code, error
-    # message, and error details. The error code should be an enum value of
-    # {Google::Rpc::Code}, but it may accept additional error codes
-    # if needed.  The error message should be a developer-facing English message
-    # that helps developers *understand* and *resolve* the error. If a localized
-    # user-facing error message is needed, put the localized message in the error
-    # details or localize it in the client. The optional error details may contain
-    # arbitrary information about the error. There is a predefined set of error
-    # detail types in the package `google.rpc` that can be used for common error
-    # conditions.
-    #
-    # = Language mapping
-    #
-    # The `Status` message is the logical representation of the error model, but it
-    # is not necessarily the actual wire format. When the `Status` message is
-    # exposed in different client libraries and different wire protocols, it can be
-    # mapped differently. For example, it will likely be mapped to some exceptions
-    # in Java, but more likely mapped to some error codes in C.
-    #
-    # = Other uses
-    #
-    # The error model and the `Status` message can be used in a variety of
-    # environments, either with or without APIs, to provide a
-    # consistent developer experience across different environments.
-    #
-    # Example uses of this error model include:
-    #
-    # * Partial errors. If a service needs to return partial errors to the client,
-    #   it may embed the `Status` in the normal response to indicate the partial
-    #   errors.
-    #
-    # * Workflow errors. A typical workflow has multiple steps. Each step may
-    #   have a `Status` message for error reporting.
-    #
-    # * Batch operations. If a client uses batch request and batch response, the
-    #   `Status` message should be used directly inside batch response, one for
-    #   each error sub-response.
-    #
-    # * Asynchronous operations. If an API call embeds asynchronous operation
-    #   results in its response, the status of those operations should be
-    #   represented directly using the `Status` message.
-    #
-    # * Logging. If some API errors are stored in logs, the message `Status` could
-    #   be used directly after any stripping needed for security/privacy reasons.
+    # You can find out more about this error model and how to work with it in the
+    # [API Design Guide](https://cloud.google.com/apis/design/errors).
     # @!attribute [rw] code
     #   @return [Integer]
-    #     The status code, which should be an enum value of
-    #     {Google::Rpc::Code}.
+    #     The status code, which should be an enum value of {Google::Rpc::Code}.
     # @!attribute [rw] message
     #   @return [String]
     #     A developer-facing error message, which should be in English. Any
     #     user-facing error message should be localized and sent in the
-    #     {Google::Rpc::Status#details} field, or localized
-    #     by the client.
+    #     {Google::Rpc::Status#details} field, or localized by the client.
     # @!attribute [rw] details
     #   @return [Array<Google::Protobuf::Any>]
     #     A list of messages that carry the error details.  There is a common set of