google-cloud-datastore-admin-v1 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e33d5502f8b0d4113341e262e74b740d8edb9299380d834ff495d5b0bd9ae4de
-  data.tar.gz: 950ece3f28cf310e612702afc1569a9530fefce61b43cd8d8358bbe38a7abeae
+  metadata.gz: a6ff3f5bfe3626f8918be4dc4ba8050e74e492f095b307e25bebafb27c6e94ff
+  data.tar.gz: d4256e82209cacd23e9541250341a003de9b8decd19b4b7d021bd41c011b53e6
 SHA512:
-  metadata.gz: 8d324990da185ad8dfc60efcaa3ca35b2077dfec85815854efe0349918518b40958c886c25339ae7854d20d183e584198abe999d2f77d62553e16b1245c9e0b4
-  data.tar.gz: 203da87729400e989e98b0123e19b698fc6b87f8387e0fa4f6bbd2de1b8a29597d755498fe400ed15d08d36062207eb8b4a8d4161fdbabecd054eada8e93d0ae
+  metadata.gz: f4871dc6b6ae3d3a4ea9086ab4c2cc471c6b27f285f25fe7c25b5be42a2dc0321559b93b62d4a87ad0c72f817b17d52e5334d85157588b00677776a74e805469
+  data.tar.gz: 6d5bc25cbb0900d54e28c318335cd3259af0d56a74a24869d6310447a19a681f8117d1eb50ab574d4df45180e9a5d99343b97d8395dfd16cf4283484119c04f3

data/README.md

@@ -6,6 +6,12 @@ Firestore in Datastore mode is a NoSQL document database built for automatic sca
 
 https://github.com/googleapis/google-cloud-ruby
 
+This gem is a _versioned_ client. It provides basic client classes for a
+specific version of the Firestore in Datastore mode Admin V1 API. Most users should consider using
+the main client gem,
+[google-cloud-datastore-admin](https://rubygems.org/gems/google-cloud-datastore-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-datastore-admin`,
+and lower-level _versioned_ client libraries with names such as
+`google-cloud-datastore-admin-v1`.
+_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-datastore-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-datastore-admin-v1`.
+
+### 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/datastore/admin/v1/datastore_admin/client.rb

@@ -205,7 +205,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/datastore/admin/v1/datastore_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::Datastore::Admin::V1::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/datastore/admin/v1/version.rb

@@ -22,7 +22,7 @@ module Google
     module Datastore
       module Admin
         module V1
-          VERSION = "0.1.2"
+          VERSION = "0.2.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/duration.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Protobuf
+    # A Duration represents a signed, fixed-length span of time represented
+    # as a count of seconds and fractions of seconds at nanosecond
+    # resolution. It is independent of any calendar and concepts like "day"
+    # or "month". It is related to Timestamp in that the difference between
+    # two Timestamp values is a Duration and it can be added or subtracted
+    # from a Timestamp. Range is approximately +-10,000 years.
+    #
+    # # Examples
+    #
+    # Example 1: Compute Duration from two Timestamps in pseudo code.
+    #
+    #     Timestamp start = ...;
+    #     Timestamp end = ...;
+    #     Duration duration = ...;
+    #
+    #     duration.seconds = end.seconds - start.seconds;
+    #     duration.nanos = end.nanos - start.nanos;
+    #
+    #     if (duration.seconds < 0 && duration.nanos > 0) {
+    #       duration.seconds += 1;
+    #       duration.nanos -= 1000000000;
+    #     } else if (duration.seconds > 0 && duration.nanos < 0) {
+    #       duration.seconds -= 1;
+    #       duration.nanos += 1000000000;
+    #     }
+    #
+    # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
+    #
+    #     Timestamp start = ...;
+    #     Duration duration = ...;
+    #     Timestamp end = ...;
+    #
+    #     end.seconds = start.seconds + duration.seconds;
+    #     end.nanos = start.nanos + duration.nanos;
+    #
+    #     if (end.nanos < 0) {
+    #       end.seconds -= 1;
+    #       end.nanos += 1000000000;
+    #     } else if (end.nanos >= 1000000000) {
+    #       end.seconds += 1;
+    #       end.nanos -= 1000000000;
+    #     }
+    #
+    # Example 3: Compute Duration from datetime.timedelta in Python.
+    #
+    #     td = datetime.timedelta(days=3, minutes=10)
+    #     duration = Duration()
+    #     duration.FromTimedelta(td)
+    #
+    # # JSON Mapping
+    #
+    # In JSON format, the Duration type is encoded as a string rather than an
+    # object, where the string ends in the suffix "s" (indicating seconds) and
+    # is preceded by the number of seconds, with nanoseconds expressed as
+    # fractional seconds. For example, 3 seconds with 0 nanoseconds should be
+    # encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
+    # be expressed in JSON format as "3.000000001s", and 3 seconds and 1
+    # microsecond should be expressed in JSON format as "3.000001s".
+    # @!attribute [rw] seconds
+    #   @return [::Integer]
+    #     Signed seconds of the span of time. Must be from -315,576,000,000
+    #     to +315,576,000,000 inclusive. Note: these bounds are computed from:
+    #     60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+    # @!attribute [rw] nanos
+    #   @return [::Integer]
+    #     Signed fractions of a second at nanosecond resolution of the span
+    #     of time. Durations less than one second are represented with a 0
+    #     `seconds` field and a positive or negative `nanos` field. For durations
+    #     of one second or more, a non-zero value for the `nanos` field must be
+    #     of the same sign as the `seconds` field. Must be from -999,999,999
+    #     to +999,999,999 inclusive.
+    class Duration
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

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-datastore-admin-v1
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-20 00:00:00.000000000 Z
+date: 2021-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -151,7 +151,10 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.9'
 description: Firestore in Datastore mode is a NoSQL document database built for automatic
-  scaling, high performance, and ease of application development.
+  scaling, high performance, and ease of application development. Note that google-cloud-datastore-admin-v1
+  is a version-specific client library. For most uses, we recommend installing the
+  main client library google-cloud-datastore-admin instead. See the readme for more
+  details.
 email: googleapis-packages@google.com
 executables: []
 extensions: []
@@ -178,6 +181,7 @@ files:
 - proto_docs/google/datastore/admin/v1/index.rb
 - proto_docs/google/longrunning/operations.rb
 - proto_docs/google/protobuf/any.rb
+- proto_docs/google/protobuf/duration.rb
 - proto_docs/google/protobuf/empty.rb
 - proto_docs/google/protobuf/timestamp.rb
 - proto_docs/google/rpc/status.rb