Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control
- Inherits:
-
Object
- Object
- Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control
- 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::GoogleCloudDiscoveryengineV1ControlBoostAction
Adjusts order of products in returned list.
-
#conditions ⇒ Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Condition>
Determines when the associated action will trigger.
-
#display_name ⇒ String
Required.
-
#filter_action ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ControlFilterAction
Specified which products may be included in results.
-
#name ⇒ String
Immutable.
-
#redirect_action ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ControlRedirectAction
Redirects a shopper to the provided URI.
-
#solution_type ⇒ String
Required.
-
#synonyms_action ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ControlSynonymsAction
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) ⇒ GoogleCloudDiscoveryengineV1Control
constructor
A new instance of GoogleCloudDiscoveryengineV1Control.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1Control
Returns a new instance of GoogleCloudDiscoveryengineV1Control.
2509 2510 2511 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2509 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
2451 2452 2453 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2451 def associated_serving_config_ids @associated_serving_config_ids end |
#boost_action ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ControlBoostAction
Adjusts order of products in returned list.
Corresponds to the JSON property boostAction
2456 2457 2458 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2456 def boost_action @boost_action end |
#conditions ⇒ Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Condition>
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
2463 2464 2465 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2463 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
2470 2471 2472 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2470 def display_name @display_name end |
#filter_action ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ControlFilterAction
Specified which products may be included in results. Uses same filter as boost.
Corresponds to the JSON property filterAction
2475 2476 2477 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2475 def filter_action @filter_action end |
#name ⇒ String
Immutable. Fully qualified name projects/*/locations/global/dataStore/*/
controls/*
Corresponds to the JSON property name
2481 2482 2483 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2481 def name @name end |
#redirect_action ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ControlRedirectAction
Redirects a shopper to the provided URI.
Corresponds to the JSON property redirectAction
2486 2487 2488 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2486 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
2492 2493 2494 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2492 def solution_type @solution_type end |
#synonyms_action ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ControlSynonymsAction
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
2499 2500 2501 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2499 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
2507 2508 2509 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2507 def use_cases @use_cases end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2514 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 |