module Google::Cloud::Retail
Constants
- VERSION
Public Class Methods
Create a new client object for CatalogService.
By default, this returns an instance of [Google::Cloud::Retail::V2::CatalogService::Client](googleapis.dev/ruby/google-cloud-retail-v2/latest/Google/Cloud/Retail/V2/CatalogService/Client.html) for version V2 of the API. However, you can specify specify a different API version by passing it in the `version` parameter. If the CatalogService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.
## About CatalogService
Service for managing catalog configuration.
@param version [::String, ::Symbol] The API version to connect to. Optional.
Defaults to `:v2`.
@return [CatalogService::Client] A client object for the specified version.
# File lib/google/cloud/retail.rb, line 66 def self.catalog_service version: :v2, &block require "google/cloud/retail/#{version.to_s.downcase}" package_name = Google::Cloud::Retail .constants .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") } .first package_module = Google::Cloud::Retail.const_get package_name package_module.const_get(:CatalogService).const_get(:Client).new(&block) end
Create a new client object for CompletionService.
By default, this returns an instance of [Google::Cloud::Retail::V2::CompletionService::Client](googleapis.dev/ruby/google-cloud-retail-v2/latest/Google/Cloud/Retail/V2/CompletionService/Client.html) for version V2 of the API. However, you can specify specify a different API version by passing it in the `version` parameter. If the CompletionService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.
## About CompletionService
Auto-completion service for retail.
This feature is only available for users who have Retail
Search enabled. Please submit a form [here](cloud.google.com/contact) to contact cloud sales if you are interested in using Retail
Search.
@param version [::String, ::Symbol] The API version to connect to. Optional.
Defaults to `:v2`.
@return [CompletionService::Client] A client object for the specified version.
# File lib/google/cloud/retail.rb, line 100 def self.completion_service version: :v2, &block require "google/cloud/retail/#{version.to_s.downcase}" package_name = Google::Cloud::Retail .constants .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") } .first package_module = Google::Cloud::Retail.const_get package_name package_module.const_get(:CompletionService).const_get(:Client).new(&block) end
Configure the google-cloud-retail library.
The following configuration parameters are supported:
-
`credentials` (type: `String, Hash, Google::Auth::Credentials`) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.
-
`lib_name` (type: `String`) - The library name as recorded in instrumentation and logging.
-
`lib_version` (type: `String`) - The library version as recorded in instrumentation and logging.
-
`interceptors` (type: `Array<GRPC::ClientInterceptor>`) - An array of interceptors that are run before calls are executed.
-
`timeout` (type: `Numeric`) - Default timeout in seconds.
-
`metadata` (type: `Hash{Symbol=>String}`) - Additional gRPC headers to be sent with the call.
-
`retry_policy` (type: `Hash`) - The retry policy. The value is a hash with the following keys:
* `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. * `:retry_codes` (*type:* `Array<String>`) - The error codes that should trigger a retry.
@return [::Google::Cloud::Config] The default configuration used by this library
# File lib/google/cloud/retail.rb, line 264 def self.configure yield ::Google::Cloud.configure.retail if block_given? ::Google::Cloud.configure.retail end
Create a new client object for PredictionService.
By default, this returns an instance of [Google::Cloud::Retail::V2::PredictionService::Client](googleapis.dev/ruby/google-cloud-retail-v2/latest/Google/Cloud/Retail/V2/PredictionService/Client.html) for version V2 of the API. However, you can specify specify a different API version by passing it in the `version` parameter. If the PredictionService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.
## About PredictionService
Service for making recommendation prediction.
@param version [::String, ::Symbol] The API version to connect to. Optional.
Defaults to `:v2`.
@return [PredictionService::Client] A client object for the specified version.
# File lib/google/cloud/retail.rb, line 130 def self.prediction_service version: :v2, &block require "google/cloud/retail/#{version.to_s.downcase}" package_name = Google::Cloud::Retail .constants .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") } .first package_module = Google::Cloud::Retail.const_get package_name package_module.const_get(:PredictionService).const_get(:Client).new(&block) end
Create a new client object for ProductService.
By default, this returns an instance of [Google::Cloud::Retail::V2::ProductService::Client](googleapis.dev/ruby/google-cloud-retail-v2/latest/Google/Cloud/Retail/V2/ProductService/Client.html) for version V2 of the API. However, you can specify specify a different API version by passing it in the `version` parameter. If the ProductService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.
## About ProductService
Service for ingesting Product information of the customer's website.
@param version [::String, ::Symbol] The API version to connect to. Optional.
Defaults to `:v2`.
@return [ProductService::Client] A client object for the specified version.
# File lib/google/cloud/retail.rb, line 161 def self.product_service version: :v2, &block require "google/cloud/retail/#{version.to_s.downcase}" package_name = Google::Cloud::Retail .constants .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") } .first package_module = Google::Cloud::Retail.const_get package_name package_module.const_get(:ProductService).const_get(:Client).new(&block) end
Create a new client object for SearchService.
By default, this returns an instance of [Google::Cloud::Retail::V2::SearchService::Client](googleapis.dev/ruby/google-cloud-retail-v2/latest/Google/Cloud/Retail/V2/SearchService/Client.html) for version V2 of the API. However, you can specify specify a different API version by passing it in the `version` parameter. If the SearchService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.
## About SearchService
Service for search.
This feature is only available for users who have Retail
Search enabled. Please submit a form [here](cloud.google.com/contact) to contact cloud sales if you are interested in using Retail
Search.
@param version [::String, ::Symbol] The API version to connect to. Optional.
Defaults to `:v2`.
@return [SearchService::Client] A client object for the specified version.
# File lib/google/cloud/retail.rb, line 195 def self.search_service version: :v2, &block require "google/cloud/retail/#{version.to_s.downcase}" package_name = Google::Cloud::Retail .constants .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") } .first package_module = Google::Cloud::Retail.const_get package_name package_module.const_get(:SearchService).const_get(:Client).new(&block) end
Create a new client object for UserEventService.
By default, this returns an instance of [Google::Cloud::Retail::V2::UserEventService::Client](googleapis.dev/ruby/google-cloud-retail-v2/latest/Google/Cloud/Retail/V2/UserEventService/Client.html) for version V2 of the API. However, you can specify specify a different API version by passing it in the `version` parameter. If the UserEventService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.
## About UserEventService
Service for ingesting end user actions on the customer website.
@param version [::String, ::Symbol] The API version to connect to. Optional.
Defaults to `:v2`.
@return [UserEventService::Client] A client object for the specified version.
# File lib/google/cloud/retail.rb, line 225 def self.user_event_service version: :v2, &block require "google/cloud/retail/#{version.to_s.downcase}" package_name = Google::Cloud::Retail .constants .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") } .first package_module = Google::Cloud::Retail.const_get package_name package_module.const_get(:UserEventService).const_get(:Client).new(&block) end