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

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

@@ -221,14 +221,26 @@ module Google
                     endpoint: @config.endpoint,
                     endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
                     universe_domain: @config.universe_domain,
-                    credentials: credentials
+                    credentials: credentials,
+                    logger: @config.logger
                   )
 
+                  @firestore_admin_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_admin_stub.endpoint
                     config.universe_domain = @firestore_admin_stub.universe_domain
+                    config.logger = @firestore_admin_stub.logger if config.respond_to? :logger=
                   end
                 end
 
@@ -246,6 +258,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
 
                 ##
@@ -336,7 +357,7 @@ module Google
                   @firestore_admin_stub.create_index request, options do |result, operation|
                     result = ::Gapic::Operation.new result, @operations_client, options: 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)
@@ -429,7 +450,7 @@ module Google
                   @firestore_admin_stub.list_indexes request, options do |result, operation|
                     result = ::Gapic::Rest::PagedEnumerable.new @firestore_admin_stub, :list_indexes, "indexes", 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)
@@ -509,7 +530,6 @@ module Google
 
                   @firestore_admin_stub.get_index 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)
@@ -589,7 +609,6 @@ module Google
 
                   @firestore_admin_stub.delete_index 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)
@@ -669,7 +688,6 @@ module Google
 
                   @firestore_admin_stub.get_field 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)
@@ -774,7 +792,7 @@ module Google
                   @firestore_admin_stub.update_field request, options do |result, operation|
                     result = ::Gapic::Operation.new result, @operations_client, options: 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)
@@ -881,7 +899,7 @@ module Google
                   @firestore_admin_stub.list_fields request, options do |result, operation|
                     result = ::Gapic::Rest::PagedEnumerable.new @firestore_admin_stub, :list_fields, "fields", 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)
@@ -919,8 +937,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
@@ -1006,7 +1024,7 @@ module Google
                   @firestore_admin_stub.export_documents request, options do |result, operation|
                     result = ::Gapic::Operation.new result, @operations_client, options: 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)
@@ -1038,8 +1056,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
@@ -1114,7 +1132,7 @@ module Google
                   @firestore_admin_stub.import_documents request, options do |result, operation|
                     result = ::Gapic::Operation.new result, @operations_client, options: 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)
@@ -1225,7 +1243,7 @@ module Google
                   @firestore_admin_stub.bulk_delete_documents request, options do |result, operation|
                     result = ::Gapic::Operation.new result, @operations_client, options: 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)
@@ -1262,7 +1280,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 [result, operation] Access the result along with the TransportOperation object
                 # @yieldparam result [::Gapic::Operation]
                 # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1324,7 +1342,7 @@ module Google
                   @firestore_admin_stub.create_database request, options do |result, operation|
                     result = ::Gapic::Operation.new result, @operations_client, options: 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)
@@ -1404,7 +1422,6 @@ module Google
 
                   @firestore_admin_stub.get_database 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)
@@ -1486,7 +1503,6 @@ module Google
 
                   @firestore_admin_stub.list_databases 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)
@@ -1575,7 +1591,7 @@ module Google
                   @firestore_admin_stub.update_database request, options do |result, operation|
                     result = ::Gapic::Operation.new result, @operations_client, options: 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)
@@ -1667,7 +1683,7 @@ module Google
                   @firestore_admin_stub.delete_database request, options do |result, operation|
                     result = ::Gapic::Operation.new result, @operations_client, options: 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)
@@ -1748,7 +1764,6 @@ module Google
 
                   @firestore_admin_stub.get_backup 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)
@@ -1832,7 +1847,6 @@ module Google
 
                   @firestore_admin_stub.list_backups 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)
@@ -1913,7 +1927,6 @@ module Google
 
                   @firestore_admin_stub.delete_backup 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)
@@ -1948,7 +1961,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).
@@ -1958,19 +1971,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 [result, operation] Access the result along with the TransportOperation object
                 # @yieldparam result [::Gapic::Operation]
                 # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -2032,7 +2054,7 @@ module Google
                   @firestore_admin_stub.restore_database request, options do |result, operation|
                     result = ::Gapic::Operation.new result, @operations_client, options: 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)
@@ -2117,7 +2139,6 @@ module Google
 
                   @firestore_admin_stub.create_backup_schedule 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)
@@ -2199,7 +2220,6 @@ module Google
 
                   @firestore_admin_stub.get_backup_schedule 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)
@@ -2280,7 +2300,6 @@ module Google
 
                   @firestore_admin_stub.list_backup_schedules 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)
@@ -2361,7 +2380,6 @@ module Google
 
                   @firestore_admin_stub.update_backup_schedule 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)
@@ -2443,7 +2461,6 @@ module Google
 
                   @firestore_admin_stub.delete_backup_schedule 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)
@@ -2523,6 +2540,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
@@ -2544,6 +2566,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/rest/operations.rb

@@ -116,14 +116,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.
@@ -205,7 +197,7 @@ module Google
                   @operations_stub.list_operations request, options do |result, operation|
                     result = ::Gapic::Rest::PagedEnumerable.new @operations_stub, :list_operations, "operations", 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)
@@ -294,7 +286,7 @@ module Google
                   @operations_stub.get_operation request, options do |result, operation|
                     result = ::Gapic::Operation.new result, @operations_client, options: 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)
@@ -376,7 +368,6 @@ module Google
 
                   @operations_stub.delete_operation 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)
@@ -391,8 +382,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
@@ -464,7 +456,6 @@ module Google
 
                   @operations_stub.cancel_operation 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)
@@ -544,6 +535,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
@@ -565,6 +561,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
@@ -684,16 +681,18 @@ module Google
 
                   response = @client_stub.make_http_request(
                     verb,
-                    uri:     uri,
-                    body:    body || "",
-                    params:  query_string_params,
+                    uri: uri,
+                    body: body || "",
+                    params: query_string_params,
+                    method_name: "list_operations",
                     options: options
                   )
                   operation = ::Gapic::Rest::TransportOperation.new response
                   result = ::Google::Longrunning::ListOperationsResponse.decode_json response.body, ignore_unknown_fields: true
-
-                  yield result, operation if block_given?
-                  result
+                  catch :response do
+                    yield result, operation if block_given?
+                    result
+                  end
                 end
 
                 ##
@@ -722,16 +721,18 @@ module Google
 
                   response = @client_stub.make_http_request(
                     verb,
-                    uri:     uri,
-                    body:    body || "",
-                    params:  query_string_params,
+                    uri: uri,
+                    body: body || "",
+                    params: query_string_params,
+                    method_name: "get_operation",
                     options: options
                   )
                   operation = ::Gapic::Rest::TransportOperation.new response
                   result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
-
-                  yield result, operation if block_given?
-                  result
+                  catch :response do
+                    yield result, operation if block_given?
+                    result
+                  end
                 end
 
                 ##
@@ -760,16 +761,18 @@ module Google
 
                   response = @client_stub.make_http_request(
                     verb,
-                    uri:     uri,
-                    body:    body || "",
-                    params:  query_string_params,
+                    uri: uri,
+                    body: body || "",
+                    params: query_string_params,
+                    method_name: "delete_operation",
                     options: options
                   )
                   operation = ::Gapic::Rest::TransportOperation.new response
                   result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
-
-                  yield result, operation if block_given?
-                  result
+                  catch :response do
+                    yield result, operation if block_given?
+                    result
+                  end
                 end
 
                 ##
@@ -798,16 +801,18 @@ module Google
 
                   response = @client_stub.make_http_request(
                     verb,
-                    uri:     uri,
-                    body:    body || "",
-                    params:  query_string_params,
+                    uri: uri,
+                    body: body || "",
+                    params: query_string_params,
+                    method_name: "cancel_operation",
                     options: options
                   )
                   operation = ::Gapic::Rest::TransportOperation.new response
                   result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
-
-                  yield result, operation if block_given?
-                  result
+                  catch :response do
+                    yield result, operation if block_given?
+                    result
+                  end
                 end
 
                 ##