Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaControl
- Inherits:
-
Object
- Object
- Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaControl
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/discoveryengine_v1/classes.rb,
lib/google/apis/discoveryengine_v1/representations.rb,
lib/google/apis/discoveryengine_v1/representations.rb
Overview
Defines a conditioned behavior to employ during serving. Must be attached to a
ServingConfig to be considered at serving time. Permitted actions dependent on
SolutionType
.
Instance Attribute Summary collapse
-
#associated_serving_config_ids ⇒ Array<String>
Output only.
-
#boost_action ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaControlBoostAction
Adjusts order of products in returned list.
-
#conditions ⇒ Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaCondition>
Determines when the associated action will trigger.
-
#display_name ⇒ String
Required.
-
#filter_action ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaControlFilterAction
Specified which products may be included in results.
-
#name ⇒ String
Immutable.
-
#redirect_action ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaControlRedirectAction
Redirects a shopper to the provided URI.
-
#solution_type ⇒ String
Required.
-
#synonyms_action ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaControlSynonymsAction
Creates a set of terms that will act as synonyms of one another.
-
#use_cases ⇒ Array<String>
Specifies the use case for the control.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1betaControl
constructor
A new instance of GoogleCloudDiscoveryengineV1betaControl.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1betaControl
Returns a new instance of GoogleCloudDiscoveryengineV1betaControl.
14717 14718 14719 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 14717 def initialize(**args) update!(**args) end |
Instance Attribute Details
#associated_serving_config_ids ⇒ Array<String>
Output only. List of all ServingConfig IDs this control is attached to. May
take up to 10 minutes to update after changes.
Corresponds to the JSON property associatedServingConfigIds
14659 14660 14661 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 14659 def associated_serving_config_ids @associated_serving_config_ids end |
#boost_action ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaControlBoostAction
Adjusts order of products in returned list.
Corresponds to the JSON property boostAction
14664 14665 14666 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 14664 def boost_action @boost_action end |
#conditions ⇒ Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaCondition>
Determines when the associated action will trigger. Omit to always apply the
action. Currently only a single condition may be specified. Otherwise an
INVALID ARGUMENT error is thrown.
Corresponds to the JSON property conditions
14671 14672 14673 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 14671 def conditions @conditions end |
#display_name ⇒ String
Required. Human readable name. The identifier used in UI views. Must be UTF-8
encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT
error is thrown.
Corresponds to the JSON property displayName
14678 14679 14680 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 14678 def display_name @display_name end |
#filter_action ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaControlFilterAction
Specified which products may be included in results. Uses same filter as boost.
Corresponds to the JSON property filterAction
14683 14684 14685 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 14683 def filter_action @filter_action end |
#name ⇒ String
Immutable. Fully qualified name projects/*/locations/global/dataStore/*/
controls/*
Corresponds to the JSON property name
14689 14690 14691 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 14689 def name @name end |
#redirect_action ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaControlRedirectAction
Redirects a shopper to the provided URI.
Corresponds to the JSON property redirectAction
14694 14695 14696 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 14694 def redirect_action @redirect_action end |
#solution_type ⇒ String
Required. Immutable. What solution the control belongs to. Must be compatible
with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.
Corresponds to the JSON property solutionType
14700 14701 14702 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 14700 def solution_type @solution_type end |
#synonyms_action ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaControlSynonymsAction
Creates a set of terms that will act as synonyms of one another. Example: "
happy" will also be considered as "glad", "glad" will also be considered as "
happy".
Corresponds to the JSON property synonymsAction
14707 14708 14709 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 14707 def synonyms_action @synonyms_action end |
#use_cases ⇒ Array<String>
Specifies the use case for the control. Affects what condition fields can be
set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case
per control. Must be set when solution_type is SolutionType.
SOLUTION_TYPE_SEARCH.
Corresponds to the JSON property useCases
14715 14716 14717 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 14715 def use_cases @use_cases end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
14722 14723 14724 14725 14726 14727 14728 14729 14730 14731 14732 14733 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 14722 def update!(**args) @associated_serving_config_ids = args[:associated_serving_config_ids] if args.key?(:associated_serving_config_ids) @boost_action = args[:boost_action] if args.key?(:boost_action) @conditions = args[:conditions] if args.key?(:conditions) @display_name = args[:display_name] if args.key?(:display_name) @filter_action = args[:filter_action] if args.key?(:filter_action) @name = args[:name] if args.key?(:name) @redirect_action = args[:redirect_action] if args.key?(:redirect_action) @solution_type = args[:solution_type] if args.key?(:solution_type) @synonyms_action = args[:synonyms_action] if args.key?(:synonyms_action) @use_cases = args[:use_cases] if args.key?(:use_cases) end |