Class: Google::Cloud::Retail::V2::Control

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/retail/v2/control.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 Attribute Details

#associated_serving_config_ids ⇒ ::Array<::String> (readonly)

Returns 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.

Returns:

  • (::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.



68
69
70
71
 
# File 'proto_docs/google/cloud/retail/v2/control.rb', line 68

class Control
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#display_name ⇒ ::String

Returns 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.

Returns:

  • (::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.



68
69
70
71
 
# File 'proto_docs/google/cloud/retail/v2/control.rb', line 68

class Control
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

Returns Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*.

Returns:

  • (::String) —

    Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*



68
69
70
71
 
# File 'proto_docs/google/cloud/retail/v2/control.rb', line 68

class Control
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#rule ⇒ ::Google::Cloud::Retail::V2::Rule

Returns A rule control - a condition-action pair. Enacts a set action when the condition is triggered. For example: Boost "gShoe" when query full matches "Running Shoes".

Returns:

  • (::Google::Cloud::Retail::V2::Rule) —

    A rule control - a condition-action pair. Enacts a set action when the condition is triggered. For example: Boost "gShoe" when query full matches "Running Shoes".



68
69
70
71
 
# File 'proto_docs/google/cloud/retail/v2/control.rb', line 68

class Control
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#search_solution_use_case ⇒ ::Array<::Google::Cloud::Retail::V2::SearchSolutionUseCase>

Returns 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.

Returns:



68
69
70
71
 
# File 'proto_docs/google/cloud/retail/v2/control.rb', line 68

class Control
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#solution_types ⇒ ::Array<::Google::Cloud::Retail::V2::SolutionType>

Returns 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.

Returns:

  • (::Array<::Google::Cloud::Retail::V2::SolutionType>) —

    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.



68
69
70
71
 
# File 'proto_docs/google/cloud/retail/v2/control.rb', line 68

class Control
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end