google-cloud-discovery_engine-v1beta 0.15.0 → 0.17.0

data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/service_stub.rb

@@ -30,7 +30,8 @@ module Google
             # including transcoding, making the REST call, and deserialing the response.
             #
             class ServiceStub
-              def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
+              # @private
+              def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, logger:
                 # These require statements are intentionally placed here to initialize
                 # the REST modules only when it's required.
                 require "gapic/rest"
@@ -40,7 +41,9 @@ module Google
                                                              universe_domain: universe_domain,
                                                              credentials: credentials,
                                                              numeric_enums: true,
-                                                             raise_faraday_errors: false
+                                                             service_name: self.class,
+                                                             raise_faraday_errors: false,
+                                                             logger: logger
               end
 
               ##
@@ -61,6 +64,15 @@ module Google
                 @client_stub.endpoint
               end
 
+              ##
+              # The logger used for request/response debug logging.
+              #
+              # @return [Logger]
+              #
+              def logger stub: false
+                stub ? @client_stub.stub_logger : @client_stub.logger
+              end
+
               ##
               # Baseline implementation for the complete_query REST call
               #
@@ -87,16 +99,58 @@ 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: "complete_query",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Cloud::DiscoveryEngine::V1beta::CompleteQueryResponse.decode_json response.body, ignore_unknown_fields: true
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
+              end
+
+              ##
+              # Baseline implementation for the advanced_complete_query REST call
+              #
+              # @param request_pb [::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryResponse]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryResponse]
+              #   A result object deserialized from the server's reply
+              def advanced_complete_query request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_advanced_complete_query_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split "=", 2 }
+                                      else
+                                        {}
+                                      end
 
-                yield result, operation if block_given?
-                result
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "advanced_complete_query",
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryResponse.decode_json response.body, ignore_unknown_fields: true
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -125,16 +179,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: "import_suggestion_deny_list_entries",
                   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
 
               ##
@@ -163,16 +219,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: "purge_suggestion_deny_list_entries",
                   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
 
               ##
@@ -201,16 +259,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: "import_completion_suggestions",
                   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
 
               ##
@@ -239,16 +299,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: "purge_completion_suggestions",
                   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
 
               ##
@@ -279,6 +341,44 @@ module Google
                 transcoder.transcode request_pb
               end
 
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the advanced_complete_query REST call
+              #
+              # @param request_pb [::Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_advanced_complete_query_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :post,
+                                                          uri_template: "/v1beta/{completion_config}:completeQuery",
+                                                          body: "*",
+                                                          matches: [
+                                                            ["completion_config", %r{^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/completionConfig/?$}, false]
+                                                          ]
+                                                        )
+                                                        .with_bindings(
+                                                          uri_method: :post,
+                                                          uri_template: "/v1beta/{completion_config}:completeQuery",
+                                                          body: "*",
+                                                          matches: [
+                                                            ["completion_config", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/completionConfig/?$}, false]
+                                                          ]
+                                                        )
+                                                        .with_bindings(
+                                                          uri_method: :post,
+                                                          uri_template: "/v1beta/{completion_config}:completeQuery",
+                                                          body: "*",
+                                                          matches: [
+                                                            ["completion_config", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/completionConfig/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+
               ##
               # @private
               #

data/lib/google/cloud/discovery_engine/v1beta/control_service/client.rb

@@ -166,14 +166,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
               )
 
+              @control_service_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 = @control_service_stub.endpoint
                 config.universe_domain = @control_service_stub.universe_domain
+                config.logger = @control_service_stub.logger if config.respond_to? :logger=
               end
             end
 
@@ -184,6 +196,15 @@ module Google
             #
             attr_reader :location_client
 
+            ##
+            # The logger used for request/response debug logging.
+            #
+            # @return [Logger]
+            #
+            def logger
+              @control_service_stub.logger
+            end
+
             # Service calls
 
             ##
@@ -211,9 +232,9 @@ module Google
             #
             #   @param parent [::String]
             #     Required. Full resource name of parent data store. Format:
-            #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
+            #     `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`
             #     or
-            #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.
+            #     `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
             #   @param control [::Google::Cloud::DiscoveryEngine::V1beta::Control, ::Hash]
             #     Required. The Control to create.
             #   @param control_id [::String]
@@ -282,7 +303,6 @@ module Google
 
               @control_service_stub.call_rpc :create_control, 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)
@@ -311,7 +331,7 @@ module Google
             #
             #   @param name [::String]
             #     Required. The resource name of the Control to delete. Format:
-            #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
+            #     `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Protobuf::Empty]
@@ -372,7 +392,6 @@ module Google
 
               @control_service_stub.call_rpc :delete_control, 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)
@@ -471,7 +490,6 @@ module Google
 
               @control_service_stub.call_rpc :update_control, 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)
@@ -497,7 +515,7 @@ module Google
             #
             #   @param name [::String]
             #     Required. The resource name of the Control to get. Format:
-            #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
+            #     `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::DiscoveryEngine::V1beta::Control]
@@ -558,7 +576,6 @@ module Google
 
               @control_service_stub.call_rpc :get_control, 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)
@@ -585,9 +602,9 @@ module Google
             #
             #   @param parent [::String]
             #     Required. The data store resource name. Format:
-            #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
+            #     `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`
             #     or
-            #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.
+            #     `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
             #   @param page_size [::Integer]
             #     Optional. Maximum number of results to return. If unspecified, defaults
             #     to 50. Max allowed value is 1000.
@@ -665,7 +682,7 @@ module Google
               @control_service_stub.call_rpc :list_controls, request, options: options do |response, operation|
                 response = ::Gapic::PagedEnumerable.new @control_service_stub, :list_controls, 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)
@@ -754,6 +771,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
@@ -778,6 +800,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/discovery_engine/v1beta/control_service/rest/client.rb

@@ -159,14 +159,26 @@ module Google
                   endpoint: @config.endpoint,
                   endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
                   universe_domain: @config.universe_domain,
-                  credentials: credentials
+                  credentials: credentials,
+                  logger: @config.logger
                 )
 
+                @control_service_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 = @control_service_stub.endpoint
                   config.universe_domain = @control_service_stub.universe_domain
+                  config.logger = @control_service_stub.logger if config.respond_to? :logger=
                 end
               end
 
@@ -177,6 +189,15 @@ module Google
               #
               attr_reader :location_client
 
+              ##
+              # The logger used for request/response debug logging.
+              #
+              # @return [Logger]
+              #
+              def logger
+                @control_service_stub.logger
+              end
+
               # Service calls
 
               ##
@@ -204,9 +225,9 @@ module Google
               #
               #   @param parent [::String]
               #     Required. Full resource name of parent data store. Format:
-              #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
+              #     `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`
               #     or
-              #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.
+              #     `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
               #   @param control [::Google::Cloud::DiscoveryEngine::V1beta::Control, ::Hash]
               #     Required. The Control to create.
               #   @param control_id [::String]
@@ -268,7 +289,6 @@ module Google
 
                 @control_service_stub.create_control 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)
@@ -297,7 +317,7 @@ module Google
               #
               #   @param name [::String]
               #     Required. The resource name of the Control to delete. Format:
-              #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
+              #     `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Google::Protobuf::Empty]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -351,7 +371,6 @@ module Google
 
                 @control_service_stub.delete_control 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)
@@ -443,7 +462,6 @@ module Google
 
                 @control_service_stub.update_control 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)
@@ -469,7 +487,7 @@ module Google
               #
               #   @param name [::String]
               #     Required. The resource name of the Control to get. Format:
-              #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
+              #     `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::Control]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -523,7 +541,6 @@ module Google
 
                 @control_service_stub.get_control 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)
@@ -550,9 +567,9 @@ module Google
               #
               #   @param parent [::String]
               #     Required. The data store resource name. Format:
-              #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
+              #     `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`
               #     or
-              #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.
+              #     `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
               #   @param page_size [::Integer]
               #     Optional. Maximum number of results to return. If unspecified, defaults
               #     to 50. Max allowed value is 1000.
@@ -623,7 +640,7 @@ module Google
                 @control_service_stub.list_controls request, options do |result, operation|
                   result = ::Gapic::Rest::PagedEnumerable.new @control_service_stub, :list_controls, "controls", 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)
@@ -703,6 +720,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
@@ -724,6 +746,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