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.



1805
1806
1807
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1805

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


1770
1771
1772
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1770

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) 


1777
1778
1779
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1777

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:



1782
1783
1784
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1782

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) 


1788
1789
1790
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1788

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:



1795
1796
1797
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1795

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. If no solution type is provided at creation time, will default to SOLUTION_TYPE_SEARCH. Corresponds to the JSON property solutionTypes

Returns:

  • (Array<String>) 


1803
1804
1805
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1803

def solution_types
  @solution_types
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1810
1811
1812
1813
1814
1815
1816
1817
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1810

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