google-cloud-firestore-v1 1.0.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a39459742546e2f2c2d7b823289fdcf0280c3d14dded7d7647311abc239b85c
-  data.tar.gz: 9d636f7b8fc6a1dc75eaeefe8c61b5c5210434204aaaf0bef958e75691b90e4a
+  metadata.gz: b67c52cee2171ce52f3400231c3499eaaed66952ff0276ef2e13524c17913157
+  data.tar.gz: 66698aca23fb4c9b1206a1d4a78d2367170e3773d9a626210e2b4003685bf2fc
 SHA512:
-  metadata.gz: e58901879bfc57a44e8027222b418e1ced0a4ee2b5844cc2adbbe5c12d3e7cc980d254f01bb270b7aafde1362ec4b784d51132b9f39eb0691b59d6a998933248
-  data.tar.gz: 3eccd75184c392e75614c4bb6e551b42622012474a8696ce40f40df9af62cb3ec6443ec7a595100a755497c047d64a1e133ecb5aee1e7632f8a06473ec0aaa89
+  metadata.gz: d0a665c4ce2a42693cc9d63845c1a2141e29c2bf38cd9323557eba0752613a0f10d7dd1ab0beae434079c50c993c68649fde760da36bd76222d2681a89b462e6
+  data.tar.gz: 79b4a3ac0c99cb05250bb5a3c7a2c6bab455b72bdc62a8ca99961780ac2ade3243b9d89e659f21b49ca33fdcf3237fd9025d04ffc0192d435311b979f87a7d07

data/README.md

@@ -43,40 +43,50 @@ for class and method documentation.
 See also the [Product Documentation](https://cloud.google.com/firestore)
 for general usage information.
 
-## Enabling Logging
-
-To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
-The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
-or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
-that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
-and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
-
-Configuring a Ruby stdlib logger:
+## Debug Logging
+
+This library comes with opt-in Debug Logging that can help you troubleshoot
+your application's integration with the API. When logging is activated, key
+events such as requests and responses, along with data payloads and metadata
+such as headers and client configuration, are logged to the standard error
+stream.
+
+**WARNING:** Client Library Debug Logging includes your data payloads in
+plaintext, which could include sensitive data such as PII for yourself or your
+customers, private keys, or other security data that could be compromising if
+leaked. Always practice good data hygiene with your application logs, and follow
+the principle of least access. Google also recommends that Client Library Debug
+Logging be enabled only temporarily during active debugging, and not used
+permanently in production.
+
+To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
+to the value `all`. Alternatively, you can set the value to a comma-delimited
+list of client library gem names. This will select the default logging behavior,
+which writes logs to the standard error stream. On a local workstation, this may
+result in logs appearing on the console. When running on a Google Cloud hosting
+service such as [Google Cloud Run](https://cloud.google.com/run), this generally
+results in logs appearing alongside your application logs in the
+[Google Cloud Logging](https://cloud.google.com/logging/) service.
+
+You can customize logging by modifying the `logger` configuration when
+constructing a client object. For example:
 
 ```ruby
+require "google/cloud/firestore/v1"
 require "logger"
 
-module MyLogger
-  LOGGER = Logger.new $stderr, level: Logger::WARN
-  def logger
-    LOGGER
-  end
-end
-
-# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
-module GRPC
-  extend MyLogger
+client = ::Google::Cloud::Firestore::V1::Firestore::Client.new do |config|
+  config.logger = Logger.new "my-app.log"
 end
 ```
 
-
 ## Google Cloud Samples
 
 To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
 
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.7+.
+This library is supported on Ruby 3.0+.
 
 Google provides official support for Ruby versions that are actively supported
 by Ruby Core—that is, Ruby versions that are either in normal maintenance or

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

@@ -240,14 +240,26 @@ module Google
                 universe_domain: @config.universe_domain,
                 channel_args: @config.channel_args,
                 interceptors: @config.interceptors,
-                channel_pool_config: @config.channel_pool
+                channel_pool_config: @config.channel_pool,
+                logger: @config.logger
               )
 
+              @firestore_stub.stub_logger&.info do |entry|
+                entry.set_system_name
+                entry.set_service
+                entry.message = "Created client for #{entry.service}"
+                entry.set_credentials_fields credentials
+                entry.set "customEndpoint", @config.endpoint if @config.endpoint
+                entry.set "defaultTimeout", @config.timeout if @config.timeout
+                entry.set "quotaProject", @quota_project_id if @quota_project_id
+              end
+
               @location_client = Google::Cloud::Location::Locations::Client.new do |config|
                 config.credentials = credentials
                 config.quota_project = @quota_project_id
                 config.endpoint = @firestore_stub.endpoint
                 config.universe_domain = @firestore_stub.universe_domain
+                config.logger = @firestore_stub.logger if config.respond_to? :logger=
               end
             end
 
@@ -258,6 +270,15 @@ module Google
             #
             attr_reader :location_client
 
+            ##
+            # The logger used for request/response debug logging.
+            #
+            # @return [Logger]
+            #
+            def logger
+              @firestore_stub.logger
+            end
+
             # Service calls
 
             ##
@@ -288,6 +309,8 @@ module Google
             #     will not be returned in the response.
             #   @param transaction [::String]
             #     Reads the document in a transaction.
+            #
+            #     Note: The following fields are mutually exclusive: `transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
             #   @param read_time [::Google::Protobuf::Timestamp, ::Hash]
             #     Reads the version of the document at the given time.
             #
@@ -295,6 +318,8 @@ module Google
             #     or if Point-in-Time Recovery is enabled, can additionally be a whole
             #     minute timestamp within the past 7 days.
             #
+            #     Note: The following fields are mutually exclusive: `read_time`, `transaction`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::Firestore::V1::Document]
             # @yieldparam operation [::GRPC::ActiveCall::Operation]
@@ -354,7 +379,6 @@ module Google
 
               @firestore_stub.call_rpc :get_document, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -418,12 +442,16 @@ module Google
             #     will not be returned in the response.
             #   @param transaction [::String]
             #     Perform the read as part of an already active transaction.
+            #
+            #     Note: The following fields are mutually exclusive: `transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
             #   @param read_time [::Google::Protobuf::Timestamp, ::Hash]
             #     Perform the read at the provided time.
             #
             #     This must be a microsecond precision timestamp within the past one hour,
             #     or if Point-in-Time Recovery is enabled, can additionally be a whole
             #     minute timestamp within the past 7 days.
+            #
+            #     Note: The following fields are mutually exclusive: `read_time`, `transaction`. If a field in that set is populated, all other fields in the set will automatically be cleared.
             #   @param show_missing [::Boolean]
             #     If the list should show missing documents.
             #
@@ -502,7 +530,7 @@ module Google
               @firestore_stub.call_rpc :list_documents, request, options: options do |response, operation|
                 response = ::Gapic::PagedEnumerable.new @firestore_stub, :list_documents, request, response, operation, options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -605,7 +633,6 @@ module Google
 
               @firestore_stub.call_rpc :update_document, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -695,7 +722,6 @@ module Google
 
               @firestore_stub.call_rpc :delete_document, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -737,11 +763,15 @@ module Google
             #     not be returned in the response.
             #   @param transaction [::String]
             #     Reads documents in a transaction.
+            #
+            #     Note: The following fields are mutually exclusive: `transaction`, `new_transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
             #   @param new_transaction [::Google::Cloud::Firestore::V1::TransactionOptions, ::Hash]
             #     Starts a new transaction and reads the documents.
             #     Defaults to a read-only transaction.
             #     The new transaction ID will be returned as the first response in the
             #     stream.
+            #
+            #     Note: The following fields are mutually exclusive: `new_transaction`, `transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
             #   @param read_time [::Google::Protobuf::Timestamp, ::Hash]
             #     Reads documents as they were at the given time.
             #
@@ -749,6 +779,8 @@ module Google
             #     or if Point-in-Time Recovery is enabled, can additionally be a whole
             #     minute timestamp within the past 7 days.
             #
+            #     Note: The following fields are mutually exclusive: `read_time`, `transaction`, `new_transaction`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Enumerable<::Google::Cloud::Firestore::V1::BatchGetDocumentsResponse>]
             # @yieldparam operation [::GRPC::ActiveCall::Operation]
@@ -811,7 +843,6 @@ module Google
 
               @firestore_stub.call_rpc :batch_get_documents, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -901,7 +932,6 @@ module Google
 
               @firestore_stub.call_rpc :begin_transaction, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -994,7 +1024,6 @@ module Google
 
               @firestore_stub.call_rpc :commit, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1083,7 +1112,6 @@ module Google
 
               @firestore_stub.call_rpc :rollback, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1120,17 +1148,23 @@ module Google
             #     Run the query within an already active transaction.
             #
             #     The value here is the opaque transaction ID to execute the query in.
+            #
+            #     Note: The following fields are mutually exclusive: `transaction`, `new_transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
             #   @param new_transaction [::Google::Cloud::Firestore::V1::TransactionOptions, ::Hash]
             #     Starts a new transaction and reads the documents.
             #     Defaults to a read-only transaction.
             #     The new transaction ID will be returned as the first response in the
             #     stream.
+            #
+            #     Note: The following fields are mutually exclusive: `new_transaction`, `transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
             #   @param read_time [::Google::Protobuf::Timestamp, ::Hash]
             #     Reads documents as they were at the given time.
             #
             #     This must be a microsecond precision timestamp within the past one hour,
             #     or if Point-in-Time Recovery is enabled, can additionally be a whole
             #     minute timestamp within the past 7 days.
+            #
+            #     Note: The following fields are mutually exclusive: `read_time`, `transaction`, `new_transaction`. If a field in that set is populated, all other fields in the set will automatically be cleared.
             #   @param explain_options [::Google::Cloud::Firestore::V1::ExplainOptions, ::Hash]
             #     Optional. Explain options for the query. If set, additional query
             #     statistics will be returned. If not, only query results will be returned.
@@ -1197,7 +1231,6 @@ module Google
 
               @firestore_stub.call_rpc :run_query, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1246,17 +1279,23 @@ module Google
             #     Run the aggregation within an already active transaction.
             #
             #     The value here is the opaque transaction ID to execute the query in.
+            #
+            #     Note: The following fields are mutually exclusive: `transaction`, `new_transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
             #   @param new_transaction [::Google::Cloud::Firestore::V1::TransactionOptions, ::Hash]
             #     Starts a new transaction as part of the query, defaulting to read-only.
             #
             #     The new transaction ID will be returned as the first response in the
             #     stream.
+            #
+            #     Note: The following fields are mutually exclusive: `new_transaction`, `transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
             #   @param read_time [::Google::Protobuf::Timestamp, ::Hash]
             #     Executes the query at the given timestamp.
             #
             #     This must be a microsecond precision timestamp within the past one hour,
             #     or if Point-in-Time Recovery is enabled, can additionally be a whole
             #     minute timestamp within the past 7 days.
+            #
+            #     Note: The following fields are mutually exclusive: `read_time`, `transaction`, `new_transaction`. If a field in that set is populated, all other fields in the set will automatically be cleared.
             #   @param explain_options [::Google::Cloud::Firestore::V1::ExplainOptions, ::Hash]
             #     Optional. Explain options for the query. If set, additional query
             #     statistics will be returned. If not, only query results will be returned.
@@ -1323,7 +1362,6 @@ module Google
 
               @firestore_stub.call_rpc :run_aggregation_query, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1461,7 +1499,7 @@ module Google
               @firestore_stub.call_rpc :partition_query, request, options: options do |response, operation|
                 response = ::Gapic::PagedEnumerable.new @firestore_stub, :partition_query, request, response, operation, options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1541,7 +1579,6 @@ module Google
 
               @firestore_stub.call_rpc :write, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1621,7 +1658,6 @@ module Google
 
               @firestore_stub.call_rpc :listen, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1721,7 +1757,6 @@ module Google
 
               @firestore_stub.call_rpc :list_collection_ids, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1825,7 +1860,6 @@ module Google
 
               @firestore_stub.call_rpc :batch_write, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1930,7 +1964,6 @@ module Google
 
               @firestore_stub.call_rpc :create_document, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1980,6 +2013,13 @@ module Google
             #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
             #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
             #    *  (`nil`) indicating no credentials
+            #
+            #   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.
+            #   For more information, refer to [Validate credential configurations from external
+            #   sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
             #   @return [::Object]
             # @!attribute [rw] scope
             #   The OAuth scopes
@@ -2019,6 +2059,11 @@ module Google
             #   default endpoint URL. The default value of nil uses the environment
             #   universe (usually the default "googleapis.com" universe).
             #   @return [::String,nil]
+            # @!attribute [rw] logger
+            #   A custom logger to use for request/response debug logging, or the value
+            #   `:default` (the default) to construct a default logger, or `nil` to
+            #   explicitly disable logging.
+            #   @return [::Logger,:default,nil]
             #
             class Configuration
               extend ::Gapic::Config
@@ -2043,6 +2088,7 @@ module Google
               config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
               config_attr :quota_project, nil, ::String, nil
               config_attr :universe_domain, nil, ::String, nil
+              config_attr :logger, :default, ::Logger, nil, :default
 
               # @private
               def initialize parent_config = nil

data/lib/google/cloud/firestore/v1/firestore/rest/client.rb

@@ -226,14 +226,26 @@ module Google
                   endpoint: @config.endpoint,
                   endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
                   universe_domain: @config.universe_domain,
-                  credentials: credentials
+                  credentials: credentials,
+                  logger: @config.logger
                 )
 
+                @firestore_stub.logger(stub: true)&.info do |entry|
+                  entry.set_system_name
+                  entry.set_service
+                  entry.message = "Created client for #{entry.service}"
+                  entry.set_credentials_fields credentials
+                  entry.set "customEndpoint", @config.endpoint if @config.endpoint
+                  entry.set "defaultTimeout", @config.timeout if @config.timeout
+                  entry.set "quotaProject", @quota_project_id if @quota_project_id
+                end
+
                 @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
                   config.credentials = credentials
                   config.quota_project = @quota_project_id
                   config.endpoint = @firestore_stub.endpoint
                   config.universe_domain = @firestore_stub.universe_domain
+                  config.logger = @firestore_stub.logger if config.respond_to? :logger=
                 end
               end
 
@@ -244,6 +256,15 @@ module Google
               #
               attr_reader :location_client
 
+              ##
+              # The logger used for request/response debug logging.
+              #
+              # @return [Logger]
+              #
+              def logger
+                @firestore_stub.logger
+              end
+
               # Service calls
 
               ##
@@ -274,12 +295,16 @@ module Google
               #     will not be returned in the response.
               #   @param transaction [::String]
               #     Reads the document in a transaction.
+              #
+              #     Note: The following fields are mutually exclusive: `transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
               #   @param read_time [::Google::Protobuf::Timestamp, ::Hash]
               #     Reads the version of the document at the given time.
               #
               #     This must be a microsecond precision timestamp within the past one hour,
               #     or if Point-in-Time Recovery is enabled, can additionally be a whole
               #     minute timestamp within the past 7 days.
+              #
+              #     Note: The following fields are mutually exclusive: `read_time`, `transaction`. If a field in that set is populated, all other fields in the set will automatically be cleared.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Google::Cloud::Firestore::V1::Document]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -333,7 +358,6 @@ module Google
 
                 @firestore_stub.get_document request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -397,12 +421,16 @@ module Google
               #     will not be returned in the response.
               #   @param transaction [::String]
               #     Perform the read as part of an already active transaction.
+              #
+              #     Note: The following fields are mutually exclusive: `transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
               #   @param read_time [::Google::Protobuf::Timestamp, ::Hash]
               #     Perform the read at the provided time.
               #
               #     This must be a microsecond precision timestamp within the past one hour,
               #     or if Point-in-Time Recovery is enabled, can additionally be a whole
               #     minute timestamp within the past 7 days.
+              #
+              #     Note: The following fields are mutually exclusive: `read_time`, `transaction`. If a field in that set is populated, all other fields in the set will automatically be cleared.
               #   @param show_missing [::Boolean]
               #     If the list should show missing documents.
               #
@@ -471,7 +499,7 @@ module Google
                 @firestore_stub.list_documents request, options do |result, operation|
                   result = ::Gapic::Rest::PagedEnumerable.new @firestore_stub, :list_documents, "documents", request, result, options
                   yield result, operation if block_given?
-                  return result
+                  throw :response, result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -567,7 +595,6 @@ module Google
 
                 @firestore_stub.update_document request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -650,7 +677,6 @@ module Google
 
                 @firestore_stub.delete_document request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -692,17 +718,23 @@ module Google
               #     not be returned in the response.
               #   @param transaction [::String]
               #     Reads documents in a transaction.
+              #
+              #     Note: The following fields are mutually exclusive: `transaction`, `new_transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
               #   @param new_transaction [::Google::Cloud::Firestore::V1::TransactionOptions, ::Hash]
               #     Starts a new transaction and reads the documents.
               #     Defaults to a read-only transaction.
               #     The new transaction ID will be returned as the first response in the
               #     stream.
+              #
+              #     Note: The following fields are mutually exclusive: `new_transaction`, `transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
               #   @param read_time [::Google::Protobuf::Timestamp, ::Hash]
               #     Reads documents as they were at the given time.
               #
               #     This must be a microsecond precision timestamp within the past one hour,
               #     or if Point-in-Time Recovery is enabled, can additionally be a whole
               #     minute timestamp within the past 7 days.
+              #
+              #     Note: The following fields are mutually exclusive: `read_time`, `transaction`, `new_transaction`. If a field in that set is populated, all other fields in the set will automatically be cleared.
               # @return [::Enumerable<::Google::Cloud::Firestore::V1::BatchGetDocumentsResponse>]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
@@ -843,7 +875,6 @@ module Google
 
                 @firestore_stub.begin_transaction request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -929,7 +960,6 @@ module Google
 
                 @firestore_stub.commit request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -1011,7 +1041,6 @@ module Google
 
                 @firestore_stub.rollback request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -1048,17 +1077,23 @@ module Google
               #     Run the query within an already active transaction.
               #
               #     The value here is the opaque transaction ID to execute the query in.
+              #
+              #     Note: The following fields are mutually exclusive: `transaction`, `new_transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
               #   @param new_transaction [::Google::Cloud::Firestore::V1::TransactionOptions, ::Hash]
               #     Starts a new transaction and reads the documents.
               #     Defaults to a read-only transaction.
               #     The new transaction ID will be returned as the first response in the
               #     stream.
+              #
+              #     Note: The following fields are mutually exclusive: `new_transaction`, `transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
               #   @param read_time [::Google::Protobuf::Timestamp, ::Hash]
               #     Reads documents as they were at the given time.
               #
               #     This must be a microsecond precision timestamp within the past one hour,
               #     or if Point-in-Time Recovery is enabled, can additionally be a whole
               #     minute timestamp within the past 7 days.
+              #
+              #     Note: The following fields are mutually exclusive: `read_time`, `transaction`, `new_transaction`. If a field in that set is populated, all other fields in the set will automatically be cleared.
               #   @param explain_options [::Google::Cloud::Firestore::V1::ExplainOptions, ::Hash]
               #     Optional. Explain options for the query. If set, additional query
               #     statistics will be returned. If not, only query results will be returned.
@@ -1168,17 +1203,23 @@ module Google
               #     Run the aggregation within an already active transaction.
               #
               #     The value here is the opaque transaction ID to execute the query in.
+              #
+              #     Note: The following fields are mutually exclusive: `transaction`, `new_transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
               #   @param new_transaction [::Google::Cloud::Firestore::V1::TransactionOptions, ::Hash]
               #     Starts a new transaction as part of the query, defaulting to read-only.
               #
               #     The new transaction ID will be returned as the first response in the
               #     stream.
+              #
+              #     Note: The following fields are mutually exclusive: `new_transaction`, `transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
               #   @param read_time [::Google::Protobuf::Timestamp, ::Hash]
               #     Executes the query at the given timestamp.
               #
               #     This must be a microsecond precision timestamp within the past one hour,
               #     or if Point-in-Time Recovery is enabled, can additionally be a whole
               #     minute timestamp within the past 7 days.
+              #
+              #     Note: The following fields are mutually exclusive: `read_time`, `transaction`, `new_transaction`. If a field in that set is populated, all other fields in the set will automatically be cleared.
               #   @param explain_options [::Google::Cloud::Firestore::V1::ExplainOptions, ::Hash]
               #     Optional. Explain options for the query. If set, additional query
               #     statistics will be returned. If not, only query results will be returned.
@@ -1370,7 +1411,7 @@ module Google
                 @firestore_stub.partition_query request, options do |result, operation|
                   result = ::Gapic::Rest::PagedEnumerable.new @firestore_stub, :partition_query, "partitions", request, result, options
                   yield result, operation if block_given?
-                  return result
+                  throw :response, result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -1464,7 +1505,7 @@ module Google
                 @firestore_stub.list_collection_ids request, options do |result, operation|
                   result = ::Gapic::Rest::PagedEnumerable.new @firestore_stub, :list_collection_ids, "collection_ids", request, result, options
                   yield result, operation if block_given?
-                  return result
+                  throw :response, result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -1561,7 +1602,6 @@ module Google
 
                 @firestore_stub.batch_write request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -1656,7 +1696,6 @@ module Google
 
                 @firestore_stub.create_document request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -1704,6 +1743,13 @@ module Google
               #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
               #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
               #    *  (`nil`) indicating no credentials
+              #
+              #   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.
+              #   For more information, refer to [Validate credential configurations from external
+              #   sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
               #   @return [::Object]
               # @!attribute [rw] scope
               #   The OAuth scopes
@@ -1736,6 +1782,11 @@ module Google
               #   default endpoint URL. The default value of nil uses the environment
               #   universe (usually the default "googleapis.com" universe).
               #   @return [::String,nil]
+              # @!attribute [rw] logger
+              #   A custom logger to use for request/response debug logging, or the value
+              #   `:default` (the default) to construct a default logger, or `nil` to
+              #   explicitly disable logging.
+              #   @return [::Logger,:default,nil]
               #
               class Configuration
                 extend ::Gapic::Config
@@ -1757,6 +1808,7 @@ module Google
                 config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
                 config_attr :quota_project, nil, ::String, nil
                 config_attr :universe_domain, nil, ::String, nil
+                config_attr :logger, :default, ::Logger, nil, :default
 
                 # @private
                 def initialize parent_config = nil