Class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/retail_v2beta/classes.rb,
lib/google/apis/retail_v2beta/representations.rb,
lib/google/apis/retail_v2beta/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) ⇒ GoogleCloudRetailV2betaControl

Returns a new instance of GoogleCloudRetailV2betaControl.



1801
1802
1803
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1801

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>) 


1767
1768
1769
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1767

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) 


1774
1775
1776
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1774

def display_name
  @display_name
end

#facet_spec ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestFacetSpec

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

Returns:



1779
1780
1781
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1779

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) 


1785
1786
1787
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1785

def name
  @name
end

#rule ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRule

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:



1792
1793
1794
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1792

def rule
  @rule
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. Corresponds to the JSON property solutionTypes

Returns:

  • (Array<String>) 


1799
1800
1801
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1799

def solution_types
  @solution_types
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1806
1807
1808
1809
1810
1811
1812
1813
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1806

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)
  @solution_types = args[:solution_types] if args.key?(:solution_types)
end