Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Control

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1Control

Returns a new instance of GoogleCloudDiscoveryengineV1Control.



3403
3404
3405
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3403

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

Returns:

  • (Array<String>) 


3338
3339
3340
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3338

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

Returns:



3343
3344
3345
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3343

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

Returns:



3350
3351
3352
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3350

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

Returns:

  • (String) 


3357
3358
3359
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3357

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

Returns:



3362
3363
3364
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3362

def filter_action
  @filter_action
end

#name ⇒ String

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

Returns:

  • (String) 


3368
3369
3370
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3368

def name
  @name
end

#promote_action ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ControlPromoteAction

Promote certain links based on some trigger queries. Example: Promote shoe store link when searching for shoe keyword. The link can be outside of associated data store. Corresponds to the JSON property promoteAction

Returns:



3375
3376
3377
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3375

def promote_action
  @promote_action
end

#redirect_action ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ControlRedirectAction

Redirects a shopper to the provided URI. Corresponds to the JSON property redirectAction

Returns:



3380
3381
3382
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3380

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

Returns:

  • (String) 


3386
3387
3388
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3386

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

Returns:



3393
3394
3395
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3393

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

Returns:

  • (Array<String>) 


3401
3402
3403
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3401

def use_cases
  @use_cases
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3408

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