Class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/retail_v2alpha/classes.rb,
lib/google/apis/retail_v2alpha/representations.rb,
lib/google/apis/retail_v2alpha/representations.rb

Overview

Configures dynamic serving time metadata that is used to pre and post process search/recommendation model results.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2alphaControl

Returns a new instance of GoogleCloudRetailV2alphaControl.



1559
1560
1561
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1559

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#associated_serving_config_ids ⇒ Array<String>

Output only. List of serving configuration ids that that are associated with this control. Note the association is managed via the ServingConfig, this is an output only denormalizeed view. Assumed to be in the same catalog. Corresponds to the JSON property associatedServingConfigIds

Returns:

  • (Array<String>) 


1516
1517
1518
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1516

def associated_serving_config_ids
  @associated_serving_config_ids
end

#display_name ⇒ String

Required. The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown. Corresponds to the JSON property displayName

Returns:

  • (String) 


1523
1524
1525
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1523

def display_name
  @display_name
end

#facet_spec ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestFacetSpec

A facet specification to perform faceted search. Corresponds to the JSON property facetSpec

Returns:



1528
1529
1530
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1528

def facet_spec
  @facet_spec
end

#name ⇒ String

Immutable. Fully qualified name projects//locations/global/catalogs// controls/* Corresponds to the JSON property name

Returns:

  • (String) 


1534
1535
1536
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1534

def name
  @name
end

#rule ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRule

A rule is a condition-action pair * A condition defines when a rule is to be triggered. * An action specifies what occurs on that trigger. Currently only boost rules are supported. Currently only supported by the search endpoint. Corresponds to the JSON property rule

Returns:



1541
1542
1543
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1541

def rule
  @rule
end

#search_solution_use_case ⇒ Array<String>

Required. Specifies the use case for the control. Affects what condition fields can be set. Only settable by search controls. Will default to SEARCH_SOLUTION_USE_CASE_SEARCH if not specified. Currently only allow one search_solution_use_case per control. Corresponds to the JSON property searchSolutionUseCase

Returns:

  • (Array<String>) 


1549
1550
1551
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1549

def search_solution_use_case
  @search_solution_use_case
end

#solution_types ⇒ Array<String>

Required. Immutable. The solution types that the serving config is used for. Currently we support setting only one type of solution at creation time. Only SOLUTION_TYPE_SEARCH value is supported at the moment. If no solution type is provided at creation time, will default to SOLUTION_TYPE_SEARCH. Corresponds to the JSON property solutionTypes

Returns:

  • (Array<String>) 


1557
1558
1559
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1557

def solution_types
  @solution_types
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1564
1565
1566
1567
1568
1569
1570
1571
1572
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1564

def update!(**args)
  @associated_serving_config_ids = args[:associated_serving_config_ids] if args.key?(:associated_serving_config_ids)
  @display_name = args[:display_name] if args.key?(:display_name)
  @facet_spec = args[:facet_spec] if args.key?(:facet_spec)
  @name = args[:name] if args.key?(:name)
  @rule = args[:rule] if args.key?(:rule)
  @search_solution_use_case = args[:search_solution_use_case] if args.key?(:search_solution_use_case)
  @solution_types = args[:solution_types] if args.key?(:solution_types)
end