google-cloud-bigtable-admin-v2 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6400ecd0f5025bb443ba7bb484f6517e3e7b5e358c33f45110a5660836bd95f4
-  data.tar.gz: 4ac222e99f305d5a56e3c6a1fe2d6761fcc34d6acbb7efd6c39d4448fdc3b320
+  metadata.gz: 1e851546fc3354fe87c5899aba92ceedb248455fab78ea983c14e63c3a3f6304
+  data.tar.gz: a33a20a24f39dd76f393e90c5b1ae0fe3ae4675aa33814ae9df4daae01d8f5ff
 SHA512:
-  metadata.gz: 6ec6558322a4cacdcf0607f94aaa6a6cfcd09c0f5132f0c7dfe5f8b55c4b08a522423f991ea8286d90da1f25c30a3b5fee165846d36dd32fdd7899d9c0042505
-  data.tar.gz: 651a7ed1a1a99632135a255317127c91e39abfe16b5908efd6644aabd6d5a0b036c3b5d5512f07b0638c01fe6919a68c7710ebf503a7fb401e336cdb836c5cf4
+  metadata.gz: 65fb698a0a3b34284e86433e9278f6ef1a3d71fe125bce1f73a699f333bb5425e88e4b4be569b2365450149fdfe69ca4bcc26ca8cfc7c0e19b9dfc17f1690e25
+  data.tar.gz: 7d1486973873ddeafa6bf2dc08ca3b3525fda8f3e93b7efcfe4cc03371b2ac408a239b87d3ac1909e678380ca066e3b40e7c1f647557b3b942067b7d2c4dd1cd

data/README.md

@@ -6,6 +6,12 @@ Cloud Bigtable is a fully managed, scalable NoSQL database service for large ana
 
 https://github.com/googleapis/google-cloud-ruby
 
+This gem is a _versioned_ client. It provides basic client classes for a
+specific version of the Cloud Bigtable Admin V2 API. Most users should consider using
+the main client gem,
+[google-cloud-bigtable-admin](https://rubygems.org/gems/google-cloud-bigtable-admin).
+See the section below titled *Which client should I use?* for more information.
+
 ## Installation
 
 ```
@@ -73,3 +79,61 @@ in security maintenance, and not end of life. Currently, this means Ruby 2.4
 and later. Older versions of Ruby _may_ still work, but are unsupported and not
 recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
 about the Ruby support schedule.
+
+## Which client should I use?
+
+Most modern Ruby client libraries for Google APIs come in two flavors: the main
+client library with a name such as `google-cloud-bigtable-admin`,
+and lower-level _versioned_ client libraries with names such as
+`google-cloud-bigtable-admin-v2`.
+_In most cases, you should install the main client._
+
+### What's the difference between the main client and a versioned client?
+
+A _versioned client_ provides a basic set of data types and client classes for
+a _single version_ of a specific service. (That is, for a service with multiple
+versions, there might be a separate versioned client for each service version.)
+Most versioned clients are written and maintained by a code generator.
+
+The _main client_ is designed to provide you with the _recommended_ client
+interfaces for the service. There will be only one main client for any given
+service, even a service with multiple versions. The main client includes
+factory methods for constructing the client objects we recommend for most
+users. In some cases, those will be classes provided by an underlying versioned
+client; in other cases, they will be handwritten higher-level client objects
+with additional capabilities, convenience methods, or best practices built in.
+Generally, the main client will default to a recommended service version,
+although in some cases you can override this if you need to talk to a specific
+service version.
+
+### Why would I want to use the main client?
+
+We recommend that most users install the main client gem for a service. You can
+identify this gem as the one _without_ a version in its name, e.g.
+`google-cloud-bigtable-admin`.
+The main client is recommended because it will embody the best practices for
+accessing the service, and may also provide more convenient interfaces or
+tighter integration into frameworks and third-party libraries. In addition, the
+documentation and samples published by Google will generally demonstrate use of
+the main client.
+
+### Why would I want to use a versioned client?
+
+You can use a versioned client if you are content with a possibly lower-level
+class interface, you explicitly want to avoid features provided by the main
+client, or you want to access a specific service version not be covered by the
+main client. You can identify versioned client gems because the service version
+is part of the name, e.g. `google-cloud-bigtable-admin-v2`.
+
+### What about the google-apis-<name> clients?
+
+Client library gems with names that begin with `google-apis-` are based on an
+older code generation technology. They talk to a REST/JSON backend (whereas
+most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
+not offer the same performance, features, and ease of use provided by more
+modern clients.
+
+The `google-apis-` clients have wide coverage across Google services, so you
+might need to use one if there is no modern client available for the service.
+However, if a modern client is available, we generally recommend it over the
+older `google-apis-` clients.

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

@@ -239,7 +239,13 @@ module Google
 
                 # Create credentials
                 credentials = @config.credentials
-                credentials ||= Credentials.default scope: @config.scope
+                # Use self-signed JWT if the scope and endpoint are unchanged from default,
+                # but only if the default endpoint does not have a region prefix.
+                enable_self_signed_jwt = @config.scope == Client.configure.scope &&
+                                         @config.endpoint == Client.configure.endpoint &&
+                                         !@config.endpoint.split(".").first.include?("-")
+                credentials ||= Credentials.default scope:                  @config.scope,
+                                                    enable_self_signed_jwt: enable_self_signed_jwt
                 if credentials.is_a?(String) || credentials.is_a?(Hash)
                   credentials = Credentials.new credentials, scope: @config.scope
                 end

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

@@ -104,8 +104,13 @@ module Google
               # Lists operations that match the specified filter in the request. If the
               # server doesn't support this method, it returns `UNIMPLEMENTED`.
               #
-              # NOTE: the `name` binding below allows API services to override the binding
-              # to use different resource name schemes, such as `users/*/operations`.
+              # NOTE: the `name` binding allows API services to override the binding
+              # to use different resource name schemes, such as `users/*/operations`. To
+              # override the binding, API services can add a binding such as
+              # `"/v1/{name=users/*}/operations"` to their service configuration.
+              # For backwards compatibility, the default name includes the operations
+              # collection id, however overriding users must ensure the name binding
+              # is the parent resource, without the operations collection id.
               #
               # @overload list_operations(request, options = nil)
               #   Pass arguments to `list_operations` via a request object, either of type
@@ -123,7 +128,7 @@ module Google
               #   the default parameter values, pass an empty Hash as a request object (see above).
               #
               #   @param name [::String]
-              #     The name of the operation collection.
+              #     The name of the operation's parent resource.
               #   @param filter [::String]
               #     The standard list filter.
               #   @param page_size [::Integer]
@@ -391,6 +396,79 @@ module Google
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
+              ##
+              # Waits for the specified long-running operation until it is done or reaches
+              # at most a specified timeout, returning the latest state.  If the operation
+              # is already done, the latest state is immediately returned.  If the timeout
+              # specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
+              # timeout is used.  If the server does not support this method, it returns
+              # `google.rpc.Code.UNIMPLEMENTED`.
+              # Note that this method is on a best-effort basis.  It may return the latest
+              # state before the specified timeout (including immediately), meaning even an
+              # immediate response is no guarantee that the operation is done.
+              #
+              # @overload wait_operation(request, options = nil)
+              #   Pass arguments to `wait_operation` via a request object, either of type
+              #   {::Google::Longrunning::WaitOperationRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Longrunning::WaitOperationRequest, ::Hash]
+              #     A request object representing the call parameters. Required. To specify no
+              #     parameters, or to keep all the default parameter values, pass an empty Hash.
+              #   @param options [::Gapic::CallOptions, ::Hash]
+              #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+              #
+              # @overload wait_operation(name: nil, timeout: nil)
+              #   Pass arguments to `wait_operation` via keyword arguments. Note that at
+              #   least one keyword argument is required. To specify no parameters, or to keep all
+              #   the default parameter values, pass an empty Hash as a request object (see above).
+              #
+              #   @param name [::String]
+              #     The name of the operation resource to wait on.
+              #   @param timeout [::Google::Protobuf::Duration, ::Hash]
+              #     The maximum duration to wait before timing out. If left blank, the wait
+              #     will be at most the time permitted by the underlying HTTP/RPC protocol.
+              #     If RPC context deadline is also specified, the shorter one will be used.
+              #
+              # @yield [response, operation] Access the result along with the RPC operation
+              # @yieldparam response [::Gapic::Operation]
+              # @yieldparam operation [::GRPC::ActiveCall::Operation]
+              #
+              # @return [::Gapic::Operation]
+              #
+              # @raise [::Google::Cloud::Error] if the RPC is aborted.
+              #
+              def wait_operation request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Longrunning::WaitOperationRequest
+
+                # Converts hash and nil to an options object
+                options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+                # Customize the options with defaults
+                metadata = @config.rpcs.wait_operation.metadata.to_h
+
+                # Set x-goog-api-client and x-goog-user-project headers
+                metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Cloud::Bigtable::Admin::V2::VERSION
+                metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.wait_operation.timeout,
+                                       metadata:     metadata,
+                                       retry_policy: @config.rpcs.wait_operation.retry_policy
+                options.apply_defaults metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
+                  response = ::Gapic::Operation.new response, @operations_client, options: options
+                  yield response, operation if block_given?
+                  return response
+                end
+              rescue ::GRPC::BadStatus => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
               ##
               # Configuration class for the Operations API.
               #
@@ -547,6 +625,11 @@ module Google
                   # @return [::Gapic::Config::Method]
                   #
                   attr_reader :cancel_operation
+                  ##
+                  # RPC-specific configuration for `wait_operation`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :wait_operation
 
                   # @private
                   def initialize parent_rpcs = nil
@@ -558,6 +641,8 @@ module Google
                     @delete_operation = ::Gapic::Config::Method.new delete_operation_config
                     cancel_operation_config = parent_rpcs&.cancel_operation if parent_rpcs&.respond_to? :cancel_operation
                     @cancel_operation = ::Gapic::Config::Method.new cancel_operation_config
+                    wait_operation_config = parent_rpcs&.wait_operation if parent_rpcs&.respond_to? :wait_operation
+                    @wait_operation = ::Gapic::Config::Method.new wait_operation_config
 
                     yield self if block_given?
                   end

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

@@ -227,7 +227,13 @@ module Google
 
                 # Create credentials
                 credentials = @config.credentials
-                credentials ||= Credentials.default scope: @config.scope
+                # Use self-signed JWT if the scope and endpoint are unchanged from default,
+                # but only if the default endpoint does not have a region prefix.
+                enable_self_signed_jwt = @config.scope == Client.configure.scope &&
+                                         @config.endpoint == Client.configure.endpoint &&
+                                         !@config.endpoint.split(".").first.include?("-")
+                credentials ||= Credentials.default scope:                  @config.scope,
+                                                    enable_self_signed_jwt: enable_self_signed_jwt
                 if credentials.is_a?(String) || credentials.is_a?(Hash)
                   credentials = Credentials.new credentials, scope: @config.scope
                 end

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

@@ -104,8 +104,13 @@ module Google
               # Lists operations that match the specified filter in the request. If the
               # server doesn't support this method, it returns `UNIMPLEMENTED`.
               #
-              # NOTE: the `name` binding below allows API services to override the binding
-              # to use different resource name schemes, such as `users/*/operations`.
+              # NOTE: the `name` binding allows API services to override the binding
+              # to use different resource name schemes, such as `users/*/operations`. To
+              # override the binding, API services can add a binding such as
+              # `"/v1/{name=users/*}/operations"` to their service configuration.
+              # For backwards compatibility, the default name includes the operations
+              # collection id, however overriding users must ensure the name binding
+              # is the parent resource, without the operations collection id.
               #
               # @overload list_operations(request, options = nil)
               #   Pass arguments to `list_operations` via a request object, either of type
@@ -123,7 +128,7 @@ module Google
               #   the default parameter values, pass an empty Hash as a request object (see above).
               #
               #   @param name [::String]
-              #     The name of the operation collection.
+              #     The name of the operation's parent resource.
               #   @param filter [::String]
               #     The standard list filter.
               #   @param page_size [::Integer]
@@ -391,6 +396,79 @@ module Google
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
+              ##
+              # Waits for the specified long-running operation until it is done or reaches
+              # at most a specified timeout, returning the latest state.  If the operation
+              # is already done, the latest state is immediately returned.  If the timeout
+              # specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
+              # timeout is used.  If the server does not support this method, it returns
+              # `google.rpc.Code.UNIMPLEMENTED`.
+              # Note that this method is on a best-effort basis.  It may return the latest
+              # state before the specified timeout (including immediately), meaning even an
+              # immediate response is no guarantee that the operation is done.
+              #
+              # @overload wait_operation(request, options = nil)
+              #   Pass arguments to `wait_operation` via a request object, either of type
+              #   {::Google::Longrunning::WaitOperationRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Longrunning::WaitOperationRequest, ::Hash]
+              #     A request object representing the call parameters. Required. To specify no
+              #     parameters, or to keep all the default parameter values, pass an empty Hash.
+              #   @param options [::Gapic::CallOptions, ::Hash]
+              #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+              #
+              # @overload wait_operation(name: nil, timeout: nil)
+              #   Pass arguments to `wait_operation` via keyword arguments. Note that at
+              #   least one keyword argument is required. To specify no parameters, or to keep all
+              #   the default parameter values, pass an empty Hash as a request object (see above).
+              #
+              #   @param name [::String]
+              #     The name of the operation resource to wait on.
+              #   @param timeout [::Google::Protobuf::Duration, ::Hash]
+              #     The maximum duration to wait before timing out. If left blank, the wait
+              #     will be at most the time permitted by the underlying HTTP/RPC protocol.
+              #     If RPC context deadline is also specified, the shorter one will be used.
+              #
+              # @yield [response, operation] Access the result along with the RPC operation
+              # @yieldparam response [::Gapic::Operation]
+              # @yieldparam operation [::GRPC::ActiveCall::Operation]
+              #
+              # @return [::Gapic::Operation]
+              #
+              # @raise [::Google::Cloud::Error] if the RPC is aborted.
+              #
+              def wait_operation request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Longrunning::WaitOperationRequest
+
+                # Converts hash and nil to an options object
+                options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+                # Customize the options with defaults
+                metadata = @config.rpcs.wait_operation.metadata.to_h
+
+                # Set x-goog-api-client and x-goog-user-project headers
+                metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Cloud::Bigtable::Admin::V2::VERSION
+                metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.wait_operation.timeout,
+                                       metadata:     metadata,
+                                       retry_policy: @config.rpcs.wait_operation.retry_policy
+                options.apply_defaults metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
+                  response = ::Gapic::Operation.new response, @operations_client, options: options
+                  yield response, operation if block_given?
+                  return response
+                end
+              rescue ::GRPC::BadStatus => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
               ##
               # Configuration class for the Operations API.
               #
@@ -547,6 +625,11 @@ module Google
                   # @return [::Gapic::Config::Method]
                   #
                   attr_reader :cancel_operation
+                  ##
+                  # RPC-specific configuration for `wait_operation`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :wait_operation
 
                   # @private
                   def initialize parent_rpcs = nil
@@ -558,6 +641,8 @@ module Google
                     @delete_operation = ::Gapic::Config::Method.new delete_operation_config
                     cancel_operation_config = parent_rpcs&.cancel_operation if parent_rpcs&.respond_to? :cancel_operation
                     @cancel_operation = ::Gapic::Config::Method.new cancel_operation_config
+                    wait_operation_config = parent_rpcs&.wait_operation if parent_rpcs&.respond_to? :wait_operation
+                    @wait_operation = ::Gapic::Config::Method.new wait_operation_config
 
                     yield self if block_given?
                   end

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

@@ -22,7 +22,7 @@ module Google
     module Bigtable
       module Admin
         module V2
-          VERSION = "0.2.1"
+          VERSION = "0.3.0"
         end
       end
     end

data/proto_docs/google/api/field_behavior.rb

@@ -54,6 +54,12 @@ module Google
       # This indicates that the field may be set once in a request to create a
       # resource, but may not be changed thereafter.
       IMMUTABLE = 5
+
+      # Denotes that a (repeated) field is an unordered list.
+      # This indicates that the service may provide the elements of the list
+      # in any arbitrary order, rather than the order the user originally
+      # provided. Additionally, the list's order may or may not be stable.
+      UNORDERED_LIST = 6
     end
   end
 end

data/proto_docs/google/longrunning/operations.rb

@@ -25,7 +25,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
@@ -35,7 +35,7 @@ module Google
     # @!attribute [rw] done
     #   @return [::Boolean]
     #     If the value is `false`, it means the operation is still in progress.
-    #     If true, the operation is completed, and either `error` or `response` is
+    #     If `true`, the operation is completed, and either `error` or `response` is
     #     available.
     # @!attribute [rw] error
     #   @return [::Google::Rpc::Status]
@@ -67,7 +67,7 @@ module Google
     # The request message for Operations.ListOperations.
     # @!attribute [rw] name
     #   @return [::String]
-    #     The name of the operation collection.
+    #     The name of the operation's parent resource.
     # @!attribute [rw] filter
     #   @return [::String]
     #     The standard list filter.
@@ -112,6 +112,20 @@ module Google
       extend ::Google::Protobuf::MessageExts::ClassMethods
     end
 
+    # The request message for Operations.WaitOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource to wait on.
+    # @!attribute [rw] timeout
+    #   @return [::Google::Protobuf::Duration]
+    #     The maximum duration to wait before timing out. If left blank, the wait
+    #     will be at most the time permitted by the underlying HTTP/RPC protocol.
+    #     If RPC context deadline is also specified, the shorter one will be used.
+    class WaitOperationRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
     # A message representing the message types used by a long-running operation.
     #
     # Example:

data/proto_docs/google/protobuf/any.rb

@@ -57,10 +57,13 @@ module Google
     #  Example 4: Pack and unpack a message in Go
     #
     #      foo := &pb.Foo{...}
-    #      any, err := ptypes.MarshalAny(foo)
+    #      any, err := anypb.New(foo)
+    #      if err != nil {
+    #        ...
+    #      }
     #      ...
     #      foo := &pb.Foo{}
-    #      if err := ptypes.UnmarshalAny(any, foo); err != nil {
+    #      if err := any.UnmarshalTo(foo); err != nil {
     #        ...
     #      }
     #

data/proto_docs/google/protobuf/timestamp.rb

@@ -70,7 +70,16 @@ module Google
     #         .setNanos((int) ((millis % 1000) * 1000000)).build();
     #
     #
-    # Example 5: Compute Timestamp from current time in Python.
+    # Example 5: Compute Timestamp from Java `Instant.now()`.
+    #
+    #     Instant now = Instant.now();
+    #
+    #     Timestamp timestamp =
+    #         Timestamp.newBuilder().setSeconds(now.getEpochSecond())
+    #             .setNanos(now.getNano()).build();
+    #
+    #
+    # Example 6: Compute Timestamp from current time in Python.
     #
     #     timestamp = Timestamp()
     #     timestamp.GetCurrentTime()

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-bigtable-admin-v2
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-26 00:00:00.000000000 Z
+date: 2021-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -171,7 +171,10 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.9'
 description: Cloud Bigtable is a fully managed, scalable NoSQL database service for
-  large analytical and operational workloads.
+  large analytical and operational workloads. Note that google-cloud-bigtable-admin-v2
+  is a version-specific client library. For most uses, we recommend installing the
+  main client library google-cloud-bigtable-admin instead. See the readme for more
+  details.
 email: googleapis-packages@google.com
 executables: []
 extensions: []