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 metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2betaControl

Returns a new instance of GoogleCloudRetailV2betaControl.



3369
3370
3371
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 3369

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#associated_serving_config_ids ⇒ Array<String>

Output only. List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view. Corresponds to the JSON property associatedServingConfigIds

Returns:

  • (Array<String>) 


3326
3327
3328
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 3326

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) 


3333
3334
3335
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 3333

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:



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

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) 


3344
3345
3346
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 3344

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 rules only work for controls with SOLUTION_TYPE_SEARCH. Corresponds to the JSON property rule

Returns:



3351
3352
3353
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 3351

def rule
  @rule
end

#search_solution_use_case ⇒ Array<String>

Specifies the use case for the control. Affects what condition fields can be set. Only settable by search controls. Will default to SEARCH_SOLUTION_USE_CASE_SEARCH if not specified. Currently only allow one search_solution_use_case per control. Corresponds to the JSON property searchSolutionUseCase

Returns:

  • (Array<String>) 


3359
3360
3361
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 3359

def search_solution_use_case
  @search_solution_use_case
end

#solution_types ⇒ Array<String>

Required. Immutable. The solution types that the control 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>) 


3367
3368
3369
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 3367

def solution_types
  @solution_types
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3374
3375
3376
3377
3378
3379
3380
3381
3382
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 3374

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