google-cloud-firestore-admin-v1 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 821c598bf011761300135cb84276918c343984e7d45b886e09cc021a85bcae3b
-  data.tar.gz: d822678f8fa7aeaa122157e44b80d8413f3966395fd52a0b1d3974ccbf518a68
+  metadata.gz: 59f3bce4b8eba2e0a9cabd07d4a3712392f53a20ec8a6f145ef992dbbba7c1b0
+  data.tar.gz: 3377348ae0e89c1c212031e1e0a8e3802abf60a9fda737a047cd2d5c53cd09db
 SHA512:
-  metadata.gz: 0a4b502e5ac1a0f85134f8991ffcaab71a110475ff8db8d41613b400ff7da19c9026f00ace6b7ee2061403d63fed09b77772abd3be3a934a7fe0180ebc28614f
-  data.tar.gz: 7136fcbe1b70ec68d856b17ca2073122477966ba6e02668abd1e3cff5f18e1dbad94cf2866cde4b2584cd7a387085117b9095eea282ffb804e4f05430a4974c7
+  metadata.gz: 5af37de864037b72cdf167032242a57675b84121dbc8a092457e179b75d7b0cc17269af1df1e09a45cea3418b840fabe275c0ebd430d3dba8e1367de9b27403f
+  data.tar.gz: b12492ff42aec8d32707d498fa69700dd0b1614a5bdab9d114f3a8e4f3703c28208965da831df0299f4a0b102852ce8e204de833f0ab409a6eaad57083828f21

data/README.md

@@ -43,33 +43,43 @@ 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/admin/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::Admin::V1::FirestoreAdmin::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).

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

@@ -228,14 +228,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_admin_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_admin_stub.endpoint
                   config.universe_domain = @firestore_admin_stub.universe_domain
+                  config.logger = @firestore_admin_stub.logger if config.respond_to? :logger=
                 end
               end
 
@@ -253,6 +265,15 @@ module Google
               #
               attr_reader :location_client
 
+              ##
+              # The logger used for request/response debug logging.
+              #
+              # @return [Logger]
+              #
+              def logger
+                @firestore_admin_stub.logger
+              end
+
               # Service calls
 
               ##
@@ -350,7 +371,7 @@ module Google
                 @firestore_admin_stub.call_rpc :create_index, request, options: options do |response, operation|
                   response = ::Gapic::Operation.new response, @operations_client, options: options
                   yield response, operation if block_given?
-                  return response
+                  throw :response, response
                 end
               rescue ::GRPC::BadStatus => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -450,7 +471,7 @@ module Google
                 @firestore_admin_stub.call_rpc :list_indexes, request, options: options do |response, operation|
                   response = ::Gapic::PagedEnumerable.new @firestore_admin_stub, :list_indexes, 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)
@@ -537,7 +558,6 @@ module Google
 
                 @firestore_admin_stub.call_rpc :get_index, 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)
@@ -624,7 +644,6 @@ module Google
 
                 @firestore_admin_stub.call_rpc :delete_index, 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)
@@ -711,7 +730,6 @@ module Google
 
                 @firestore_admin_stub.call_rpc :get_field, 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)
@@ -823,7 +841,7 @@ module Google
                 @firestore_admin_stub.call_rpc :update_field, request, options: options do |response, operation|
                   response = ::Gapic::Operation.new response, @operations_client, options: options
                   yield response, operation if block_given?
-                  return response
+                  throw :response, response
                 end
               rescue ::GRPC::BadStatus => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -937,7 +955,7 @@ module Google
                 @firestore_admin_stub.call_rpc :list_fields, request, options: options do |response, operation|
                   response = ::Gapic::PagedEnumerable.new @firestore_admin_stub, :list_fields, 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)
@@ -975,8 +993,8 @@ module Google
               #     Required. Database to export. Should be of the form:
               #     `projects/{project_id}/databases/{database_id}`.
               #   @param collection_ids [::Array<::String>]
-              #     Which collection ids to export. Unspecified means all collections. Each
-              #     collection id in this list must be unique.
+              #     Which collection IDs to export. Unspecified means all collections. Each
+              #     collection ID in this list must be unique.
               #   @param output_uri_prefix [::String]
               #     The output URI. Currently only supports Google Cloud Storage URIs of the
               #     form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name
@@ -1069,7 +1087,7 @@ module Google
                 @firestore_admin_stub.call_rpc :export_documents, request, options: options do |response, operation|
                   response = ::Gapic::Operation.new response, @operations_client, options: options
                   yield response, operation if block_given?
-                  return response
+                  throw :response, response
                 end
               rescue ::GRPC::BadStatus => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -1101,8 +1119,8 @@ module Google
               #     Required. Database to import into. Should be of the form:
               #     `projects/{project_id}/databases/{database_id}`.
               #   @param collection_ids [::Array<::String>]
-              #     Which collection ids to import. Unspecified means all collections included
-              #     in the import. Each collection id in this list must be unique.
+              #     Which collection IDs to import. Unspecified means all collections included
+              #     in the import. Each collection ID in this list must be unique.
               #   @param input_uri_prefix [::String]
               #     Location of the exported files.
               #     This must match the output_uri_prefix of an ExportDocumentsResponse from
@@ -1184,7 +1202,7 @@ module Google
                 @firestore_admin_stub.call_rpc :import_documents, request, options: options do |response, operation|
                   response = ::Gapic::Operation.new response, @operations_client, options: options
                   yield response, operation if block_given?
-                  return response
+                  throw :response, response
                 end
               rescue ::GRPC::BadStatus => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -1302,7 +1320,7 @@ module Google
                 @firestore_admin_stub.call_rpc :bulk_delete_documents, request, options: options do |response, operation|
                   response = ::Gapic::Operation.new response, @operations_client, options: options
                   yield response, operation if block_given?
-                  return response
+                  throw :response, response
                 end
               rescue ::GRPC::BadStatus => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -1339,7 +1357,7 @@ module Google
               #     with first character a letter and the last a letter or a number. Must not
               #     be UUID-like /[0-9a-f]\\{8}(-[0-9a-f]\\{4})\\{3}-[0-9a-f]\\{12}/.
               #
-              #     "(default)" database id is also valid.
+              #     "(default)" database ID is also valid.
               #
               # @yield [response, operation] Access the result along with the RPC operation
               # @yieldparam response [::Gapic::Operation]
@@ -1408,7 +1426,7 @@ module Google
                 @firestore_admin_stub.call_rpc :create_database, request, options: options do |response, operation|
                   response = ::Gapic::Operation.new response, @operations_client, options: options
                   yield response, operation if block_given?
-                  return response
+                  throw :response, response
                 end
               rescue ::GRPC::BadStatus => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -1495,7 +1513,6 @@ module Google
 
                 @firestore_admin_stub.call_rpc :get_database, 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)
@@ -1584,7 +1601,6 @@ module Google
 
                 @firestore_admin_stub.call_rpc :list_databases, 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)
@@ -1680,7 +1696,7 @@ module Google
                 @firestore_admin_stub.call_rpc :update_database, request, options: options do |response, operation|
                   response = ::Gapic::Operation.new response, @operations_client, options: options
                   yield response, operation if block_given?
-                  return response
+                  throw :response, response
                 end
               rescue ::GRPC::BadStatus => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -1779,7 +1795,7 @@ module Google
                 @firestore_admin_stub.call_rpc :delete_database, request, options: options do |response, operation|
                   response = ::Gapic::Operation.new response, @operations_client, options: options
                   yield response, operation if block_given?
-                  return response
+                  throw :response, response
                 end
               rescue ::GRPC::BadStatus => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -1867,7 +1883,6 @@ module Google
 
                 @firestore_admin_stub.call_rpc :get_backup, 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)
@@ -1958,7 +1973,6 @@ module Google
 
                 @firestore_admin_stub.call_rpc :list_backups, 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)
@@ -2046,7 +2060,6 @@ module Google
 
                 @firestore_admin_stub.call_rpc :delete_backup, 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)
@@ -2081,7 +2094,7 @@ module Google
               #   @param options [::Gapic::CallOptions, ::Hash]
               #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
               #
-              # @overload restore_database(parent: nil, database_id: nil, backup: nil)
+              # @overload restore_database(parent: nil, database_id: nil, backup: nil, encryption_config: nil)
               #   Pass arguments to `restore_database` 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).
@@ -2091,19 +2104,28 @@ module Google
               #     `projects/{project_id}`.
               #   @param database_id [::String]
               #     Required. The ID to use for the database, which will become the final
-              #     component of the database's resource name. This database id must not be
+              #     component of the database's resource name. This database ID must not be
               #     associated with an existing database.
               #
               #     This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/
               #     with first character a letter and the last a letter or a number. Must not
               #     be UUID-like /[0-9a-f]\\{8}(-[0-9a-f]\\{4})\\{3}-[0-9a-f]\\{12}/.
               #
-              #     "(default)" database id is also valid.
+              #     "(default)" database ID is also valid.
               #   @param backup [::String]
               #     Required. Backup to restore from. Must be from the same project as the
               #     parent.
               #
+              #     The restored database will be created in the same location as the source
+              #     backup.
+              #
               #     Format is: `projects/{project_id}/locations/{location}/backups/{backup}`
+              #   @param encryption_config [::Google::Cloud::Firestore::Admin::V1::Database::EncryptionConfig, ::Hash]
+              #     Optional. Encryption configuration for the restored database.
+              #
+              #     If this field is not specified, the restored database will use
+              #     the same encryption configuration as the backup, namely
+              #     {::Google::Cloud::Firestore::Admin::V1::Database::EncryptionConfig#use_source_encryption use_source_encryption}.
               #
               # @yield [response, operation] Access the result along with the RPC operation
               # @yieldparam response [::Gapic::Operation]
@@ -2172,7 +2194,7 @@ module Google
                 @firestore_admin_stub.call_rpc :restore_database, request, options: options do |response, operation|
                   response = ::Gapic::Operation.new response, @operations_client, options: options
                   yield response, operation if block_given?
-                  return response
+                  throw :response, response
                 end
               rescue ::GRPC::BadStatus => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -2264,7 +2286,6 @@ module Google
 
                 @firestore_admin_stub.call_rpc :create_backup_schedule, 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)
@@ -2353,7 +2374,6 @@ module Google
 
                 @firestore_admin_stub.call_rpc :get_backup_schedule, 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)
@@ -2441,7 +2461,6 @@ module Google
 
                 @firestore_admin_stub.call_rpc :list_backup_schedules, 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)
@@ -2529,7 +2548,6 @@ module Google
 
                 @firestore_admin_stub.call_rpc :update_backup_schedule, 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)
@@ -2618,7 +2636,6 @@ module Google
 
                 @firestore_admin_stub.call_rpc :delete_backup_schedule, 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)
@@ -2707,6 +2724,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
@@ -2731,6 +2753,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/admin/v1/firestore_admin/operations.rb

@@ -125,14 +125,6 @@ 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 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
               #   {::Google::Longrunning::ListOperationsRequest} or an equivalent Hash.
@@ -222,7 +214,7 @@ module Google
                   wrap_lro_operation = ->(op_response) { ::Gapic::Operation.new op_response, @operations_client }
                   response = ::Gapic::PagedEnumerable.new @operations_stub, :list_operations, request, response, operation, options, format_resource: wrap_lro_operation
                   yield response, operation if block_given?
-                  return response
+                  throw :response, response
                 end
               rescue ::GRPC::BadStatus => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -318,7 +310,7 @@ module Google
                 @operations_stub.call_rpc :get_operation, request, options: options do |response, operation|
                   response = ::Gapic::Operation.new response, @operations_client, options: options
                   yield response, operation if block_given?
-                  return response
+                  throw :response, response
                 end
               rescue ::GRPC::BadStatus => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -407,7 +399,6 @@ module Google
 
                 @operations_stub.call_rpc :delete_operation, 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)
@@ -422,8 +413,9 @@ module Google
               # other methods to check whether the cancellation succeeded or whether the
               # operation completed despite cancellation. On successful cancellation,
               # the operation is not deleted; instead, it becomes an operation with
-              # an {::Google::Longrunning::Operation#error Operation.error} value with a {::Google::Rpc::Status#code google.rpc.Status.code} of 1,
-              # corresponding to `Code.CANCELLED`.
+              # an {::Google::Longrunning::Operation#error Operation.error} value with a
+              # {::Google::Rpc::Status#code google.rpc.Status.code} of `1`, corresponding to
+              # `Code.CANCELLED`.
               #
               # @overload cancel_operation(request, options = nil)
               #   Pass arguments to `cancel_operation` via a request object, either of type
@@ -502,7 +494,6 @@ module Google
 
                 @operations_stub.call_rpc :cancel_operation, 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)
@@ -600,7 +591,7 @@ module Google
                 @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
+                  throw :response, response
                 end
               rescue ::GRPC::BadStatus => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -689,6 +680,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
@@ -713,6 +709,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/admin/v1/firestore_admin/paths.rb

@@ -158,6 +158,25 @@ module Google
                 "projects/#{project}/locations/#{location}"
               end
 
+              ##
+              # Create a fully-qualified Operation resource string.
+              #
+              # The resource will be in the following format:
+              #
+              # `projects/{project}/databases/{database}/operations/{operation}`
+              #
+              # @param project [String]
+              # @param database [String]
+              # @param operation [String]
+              #
+              # @return [::String]
+              def operation_path project:, database:, operation:
+                raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                raise ::ArgumentError, "database cannot contain /" if database.to_s.include? "/"
+
+                "projects/#{project}/databases/#{database}/operations/#{operation}"
+              end
+
               ##
               # Create a fully-qualified Project resource string.
               #