Class: Google::Cloud::DiscoveryEngine::V1beta::RecommendationService::Client
- Inherits:
-
Object
- Object
- Google::Cloud::DiscoveryEngine::V1beta::RecommendationService::Client
- Includes:
- Paths
- Defined in:
- lib/google/cloud/discovery_engine/v1beta/recommendation_service/client.rb
Overview
Client for the RecommendationService service.
Service for making recommendations.
Defined Under Namespace
Classes: Configuration
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the RecommendationService Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the RecommendationService Client instance.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new RecommendationService client object.
-
#recommend(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::RecommendResponse
Makes a recommendation, which requires a contextual user event.
Methods included from Paths
#document_path, #serving_config_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new RecommendationService client object.
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 |
# File 'lib/google/cloud/discovery_engine/v1beta/recommendation_service/client.rb', line 114 def initialize # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "gapic/grpc" require "google/cloud/discoveryengine/v1beta/recommendation_service_services_pb" # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT && !@config.endpoint.split(".").first.include?("-") credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @recommendation_service_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::DiscoveryEngine::V1beta::RecommendationService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the RecommendationService Client class.
See Configuration for a description of the configuration fields.
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 |
# File 'lib/google/cloud/discovery_engine/v1beta/recommendation_service/client.rb', line 56 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "DiscoveryEngine", "V1beta"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config.timeout = 5.0 default_config.retry_policy = { initial_delay: 0.1, max_delay: 5.0, multiplier: 1.3, retry_codes: [14] } default_config end yield @configure if block_given? @configure end |
Instance Method Details
#configure {|config| ... } ⇒ Client::Configuration
Configure the RecommendationService Client instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.
See Configuration for a description of the configuration fields.
93 94 95 96 |
# File 'lib/google/cloud/discovery_engine/v1beta/recommendation_service/client.rb', line 93 def configure yield @config if block_given? @config end |
#recommend(request, options = nil) ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::RecommendResponse #recommend(serving_config: nil, user_event: nil, page_size: nil, filter: nil, validate_only: nil, params: nil, user_labels: nil) ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::RecommendResponse
Makes a recommendation, which requires a contextual user event.
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 |
# File 'lib/google/cloud/discovery_engine/v1beta/recommendation_service/client.rb', line 290 def recommend request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::RecommendRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.recommend..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.serving_config header_params["serving_config"] = request.serving_config end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.recommend.timeout, metadata: , retry_policy: @config.rpcs.recommend.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @recommendation_service_stub.call_rpc :recommend, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |