google-cloud-firestore-admin-v1 1.8.0 → 1.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 461f4a8be6b0d73cf844ab3ba230695e38934fdce624fe69958bb7737983527a
-  data.tar.gz: 69ebf187cdd910e9c00b311a529fe34f7964312751f0960cecfd7d38786b8c42
+  metadata.gz: 2625438b5d0f9ad3b8a29c71b99995dca8c69860c27ada81e21aa28bab5678f9
+  data.tar.gz: 9402f08d45b57a34db6082aa32e7d38bd4a04cbd016545e18e8ed9be8aff5deb
 SHA512:
-  metadata.gz: e3a5f6625de8658c73d0ccd540dddc19668e633bc7ca20dfbfedf3ade5a31f223f1ea70b5c94bc78953ea86a787e67ff8705beb821277fb68f6caae156b91ea2
-  data.tar.gz: 6f6cf7ee535f950e564ac80276fd49810eb707658a9390534226a04c7b8df578a9b80c221686baf2e77cf2326d4224a0db153233231d4a81f670fb9c59df054b
+  metadata.gz: 2088b014f943433a83721a594b3397a2ad2d89c479bb171acc54fd0652eca27171757f5cdc85fde795961ad2c52f74ad9182d2217d88817b39097473aa0f3a85
+  data.tar.gz: 321357247e7a5fdbef3118b3fa86cb20b30ebe3b70479ceb9374d79ac2467a2b0df92c47681d26d1408ece89486d588cc67ab525e5dbd689ee26e95e08f5cb6c

data/lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb

@@ -3460,8 +3460,6 @@ module Google
               #   @return [::String,nil]
               # @!attribute [rw] credentials
               #   Credentials to send with calls. You may provide any of the following types:
-              #    *  (`String`) The path to a service account key file in JSON format
-              #    *  (`Hash`) A service account key as a Hash
               #    *  (`Google::Auth::Credentials`) A googleauth credentials object
               #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
               #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -3470,7 +3468,26 @@ module Google
               #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
               #    *  (`nil`) indicating no credentials
               #
-              #   Warning: If you accept a credential configuration (JSON file or Hash) from an
+              #   @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
+              #     is deprecated. Providing an unvalidated credential configuration to
+              #     Google APIs can compromise the security of your systems and data.
+              #
+              #   @example
+              #
+              #     # The recommended way to provide credentials is to use the `make_creds` method
+              #     # on the appropriate credentials class for your environment.
+              #
+              #     require "googleauth"
+              #
+              #     credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
+              #       json_key_io: ::File.open("/path/to/keyfile.json")
+              #     )
+              #
+              #     client = ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new do |config|
+              #       config.credentials = credentials
+              #     end
+              #
+              #   @note Warning: If you accept a credential configuration (JSON file or Hash) from an
               #   external source for authentication to Google Cloud, you must validate it before
               #   providing it to a Google API client library. Providing an unvalidated credential
               #   configuration to Google APIs can compromise the security of your systems and data.

data/lib/google/cloud/firestore/admin/v1/firestore_admin/operations.rb

@@ -135,7 +135,7 @@ module Google
               #   @param options [::Gapic::CallOptions, ::Hash]
               #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
               #
-              # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil)
+              # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil)
               #   Pass arguments to `list_operations` 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).
@@ -148,6 +148,17 @@ module Google
               #     The standard list page size.
               #   @param page_token [::String]
               #     The standard list page token.
+              #   @param return_partial_success [::Boolean]
+              #     When set to `true`, operations that are reachable are returned as normal,
+              #     and those that are unreachable are returned in the
+              #     [ListOperationsResponse.unreachable] field.
+              #
+              #     This can only be `true` when reading across collections e.g. when `parent`
+              #     is set to `"projects/example/locations/-"`.
+              #
+              #     This field is not by default supported and will result in an
+              #     `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
+              #     service or product specific documentation.
               #
               # @yield [response, operation] Access the result along with the RPC operation
               # @yieldparam response [::Gapic::PagedEnumerable<::Gapic::Operation>]
@@ -632,8 +643,6 @@ module Google
               #   @return [::String,nil]
               # @!attribute [rw] credentials
               #   Credentials to send with calls. You may provide any of the following types:
-              #    *  (`String`) The path to a service account key file in JSON format
-              #    *  (`Hash`) A service account key as a Hash
               #    *  (`Google::Auth::Credentials`) A googleauth credentials object
               #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
               #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -642,7 +651,26 @@ module Google
               #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
               #    *  (`nil`) indicating no credentials
               #
-              #   Warning: If you accept a credential configuration (JSON file or Hash) from an
+              #   @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
+              #     is deprecated. Providing an unvalidated credential configuration to
+              #     Google APIs can compromise the security of your systems and data.
+              #
+              #   @example
+              #
+              #     # The recommended way to provide credentials is to use the `make_creds` method
+              #     # on the appropriate credentials class for your environment.
+              #
+              #     require "googleauth"
+              #
+              #     credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
+              #       json_key_io: ::File.open("/path/to/keyfile.json")
+              #     )
+              #
+              #     client = ::Google::Longrunning::Operations::Client.new do |config|
+              #       config.credentials = credentials
+              #     end
+              #
+              #   @note Warning: If you accept a credential configuration (JSON file or Hash) from an
               #   external source for authentication to Google Cloud, you must validate it before
               #   providing it to a Google API client library. Providing an unvalidated credential
               #   configuration to Google APIs can compromise the security of your systems and data.

data/lib/google/cloud/firestore/admin/v1/firestore_admin/rest/operations.rb

@@ -126,7 +126,7 @@ module Google
                 #   @param options [::Gapic::CallOptions, ::Hash]
                 #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
                 #
-                # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil)
+                # @overload list_operations(name: nil, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil)
                 #   Pass arguments to `list_operations` 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).
@@ -139,6 +139,17 @@ module Google
                 #     The standard list page size.
                 #   @param page_token [::String]
                 #     The standard list page token.
+                #   @param return_partial_success [::Boolean]
+                #     When set to `true`, operations that are reachable are returned as normal,
+                #     and those that are unreachable are returned in the
+                #     [ListOperationsResponse.unreachable] field.
+                #
+                #     This can only be `true` when reading across collections e.g. when `parent`
+                #     is set to `"projects/example/locations/-"`.
+                #
+                #     This field is not by default supported and will result in an
+                #     `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
+                #     service or product specific documentation.
                 # @yield [result, operation] Access the result along with the TransportOperation object
                 # @yieldparam result [::Gapic::Operation]
                 # @yieldparam operation [::Gapic::Rest::TransportOperation]

data/lib/google/cloud/firestore/admin/v1/version.rb

@@ -22,7 +22,7 @@ module Google
     module Firestore
       module Admin
         module V1
-          VERSION = "1.8.0"
+          VERSION = "1.9.1"
         end
       end
     end

data/proto_docs/google/longrunning/operations.rb

@@ -83,6 +83,18 @@ module Google
     # @!attribute [rw] page_token
     #   @return [::String]
     #     The standard list page token.
+    # @!attribute [rw] return_partial_success
+    #   @return [::Boolean]
+    #     When set to `true`, operations that are reachable are returned as normal,
+    #     and those that are unreachable are returned in the
+    #     [ListOperationsResponse.unreachable] field.
+    #
+    #     This can only be `true` when reading across collections e.g. when `parent`
+    #     is set to `"projects/example/locations/-"`.
+    #
+    #     This field is not by default supported and will result in an
+    #     `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
+    #     service or product specific documentation.
     class ListOperationsRequest
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -96,6 +108,12 @@ module Google
     # @!attribute [rw] next_page_token
     #   @return [::String]
     #     The standard List next-page token.
+    # @!attribute [rw] unreachable
+    #   @return [::Array<::String>]
+    #     Unordered list. Unreachable resources. Populated when the request sets
+    #     `ListOperationsRequest.return_partial_success` and reads across
+    #     collections e.g. when attempting to list all resources across all supported
+    #     locations.
     class ListOperationsResponse
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-firestore-admin-v1
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.1
 platform: ruby
 authors:
 - Google LLC