Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::Control.
Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#associated_serving_config_ids
def associated_serving_config_ids() -> ::Array<::String>
-
(::Array<::String>) — Output only. List of [serving
configuration][google.cloud.retail.v2.ServingConfig] 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.
#display_name
def display_name() -> ::String
-
(::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.
#display_name=
def display_name=(value) -> ::String
-
value (::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.
-
(::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.
#name
def name() -> ::String
-
(::String) — Immutable. Fully qualified name
projects/*/locations/global/catalogs/*/controls/*
#name=
def name=(value) -> ::String
-
value (::String) — Immutable. Fully qualified name
projects/*/locations/global/catalogs/*/controls/*
-
(::String) — Immutable. Fully qualified name
projects/*/locations/global/catalogs/*/controls/*
#rule
def rule() -> ::Google::Cloud::Retail::V2::Rule
- (::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".
#rule=
def rule=(value) -> ::Google::Cloud::Retail::V2::Rule
- value (::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".
- (::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".
#search_solution_use_case
def search_solution_use_case() -> ::Array<::Google::Cloud::Retail::V2::SearchSolutionUseCase>
- (::Array<::Google::Cloud::Retail::V2::SearchSolutionUseCase>) — 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.
#search_solution_use_case=
def search_solution_use_case=(value) -> ::Array<::Google::Cloud::Retail::V2::SearchSolutionUseCase>
- value (::Array<::Google::Cloud::Retail::V2::SearchSolutionUseCase>) — 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.
- (::Array<::Google::Cloud::Retail::V2::SearchSolutionUseCase>) — 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.
#solution_types
def solution_types() -> ::Array<::Google::Cloud::Retail::V2::SolutionType>
-
(::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.
#solution_types=
def solution_types=(value) -> ::Array<::Google::Cloud::Retail::V2::SolutionType>
-
value (::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.
-
(::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.