Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::Control.
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.
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 all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.
#boost_action
def boost_action() -> ::Google::Cloud::DiscoveryEngine::V1beta::Control::BoostAction- (::Google::Cloud::DiscoveryEngine::V1beta::Control::BoostAction) — Defines a boost-type control
Note: The following fields are mutually exclusive:
boost_action,filter_action,redirect_action,synonyms_action. If a field in that set is populated, all other fields in the set will automatically be cleared.
#boost_action=
def boost_action=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::Control::BoostAction- value (::Google::Cloud::DiscoveryEngine::V1beta::Control::BoostAction) — Defines a boost-type control
Note: The following fields are mutually exclusive:
boost_action,filter_action,redirect_action,synonyms_action. If a field in that set is populated, all other fields in the set will automatically be cleared.
- (::Google::Cloud::DiscoveryEngine::V1beta::Control::BoostAction) — Defines a boost-type control
Note: The following fields are mutually exclusive:
boost_action,filter_action,redirect_action,synonyms_action. If a field in that set is populated, all other fields in the set will automatically be cleared.
#conditions
def conditions() -> ::Array<::Google::Cloud::DiscoveryEngine::V1beta::Condition>- (::Array<::Google::Cloud::DiscoveryEngine::V1beta::Condition>) — 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.
#conditions=
def conditions=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1beta::Condition>- value (::Array<::Google::Cloud::DiscoveryEngine::V1beta::Condition>) — 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.
- (::Array<::Google::Cloud::DiscoveryEngine::V1beta::Condition>) — 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.
#display_name
def display_name() -> ::String- (::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.
#display_name=
def display_name=(value) -> ::String- value (::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.
- (::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.
#filter_action
def filter_action() -> ::Google::Cloud::DiscoveryEngine::V1beta::Control::FilterAction- (::Google::Cloud::DiscoveryEngine::V1beta::Control::FilterAction) — Defines a filter-type control Currently not supported by Recommendation
Note: The following fields are mutually exclusive:
filter_action,boost_action,redirect_action,synonyms_action. If a field in that set is populated, all other fields in the set will automatically be cleared.
#filter_action=
def filter_action=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::Control::FilterAction- value (::Google::Cloud::DiscoveryEngine::V1beta::Control::FilterAction) — Defines a filter-type control Currently not supported by Recommendation
Note: The following fields are mutually exclusive:
filter_action,boost_action,redirect_action,synonyms_action. If a field in that set is populated, all other fields in the set will automatically be cleared.
- (::Google::Cloud::DiscoveryEngine::V1beta::Control::FilterAction) — Defines a filter-type control Currently not supported by Recommendation
Note: The following fields are mutually exclusive:
filter_action,boost_action,redirect_action,synonyms_action. If a field in that set is populated, all other fields in the set will automatically be cleared.
#name
def name() -> ::String- (::String) — Immutable. Fully qualified name
projects/*/locations/global/dataStore/*/controls/*
#name=
def name=(value) -> ::String- value (::String) — Immutable. Fully qualified name
projects/*/locations/global/dataStore/*/controls/*
- (::String) — Immutable. Fully qualified name
projects/*/locations/global/dataStore/*/controls/*
#redirect_action
def redirect_action() -> ::Google::Cloud::DiscoveryEngine::V1beta::Control::RedirectAction- (::Google::Cloud::DiscoveryEngine::V1beta::Control::RedirectAction) — Defines a redirect-type control.
Note: The following fields are mutually exclusive:
redirect_action,boost_action,filter_action,synonyms_action. If a field in that set is populated, all other fields in the set will automatically be cleared.
#redirect_action=
def redirect_action=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::Control::RedirectAction- value (::Google::Cloud::DiscoveryEngine::V1beta::Control::RedirectAction) — Defines a redirect-type control.
Note: The following fields are mutually exclusive:
redirect_action,boost_action,filter_action,synonyms_action. If a field in that set is populated, all other fields in the set will automatically be cleared.
- (::Google::Cloud::DiscoveryEngine::V1beta::Control::RedirectAction) — Defines a redirect-type control.
Note: The following fields are mutually exclusive:
redirect_action,boost_action,filter_action,synonyms_action. If a field in that set is populated, all other fields in the set will automatically be cleared.
#solution_type
def solution_type() -> ::Google::Cloud::DiscoveryEngine::V1beta::SolutionType- (::Google::Cloud::DiscoveryEngine::V1beta::SolutionType) — Required. Immutable. What solution the control belongs to.
Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.
#solution_type=
def solution_type=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::SolutionType- value (::Google::Cloud::DiscoveryEngine::V1beta::SolutionType) — Required. Immutable. What solution the control belongs to.
Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.
- (::Google::Cloud::DiscoveryEngine::V1beta::SolutionType) — Required. Immutable. What solution the control belongs to.
Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.
#synonyms_action
def synonyms_action() -> ::Google::Cloud::DiscoveryEngine::V1beta::Control::SynonymsAction- (::Google::Cloud::DiscoveryEngine::V1beta::Control::SynonymsAction) — Treats a group of terms as synonyms of one another.
Note: The following fields are mutually exclusive:
synonyms_action,boost_action,filter_action,redirect_action. If a field in that set is populated, all other fields in the set will automatically be cleared.
#synonyms_action=
def synonyms_action=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::Control::SynonymsAction- value (::Google::Cloud::DiscoveryEngine::V1beta::Control::SynonymsAction) — Treats a group of terms as synonyms of one another.
Note: The following fields are mutually exclusive:
synonyms_action,boost_action,filter_action,redirect_action. If a field in that set is populated, all other fields in the set will automatically be cleared.
- (::Google::Cloud::DiscoveryEngine::V1beta::Control::SynonymsAction) — Treats a group of terms as synonyms of one another.
Note: The following fields are mutually exclusive:
synonyms_action,boost_action,filter_action,redirect_action. If a field in that set is populated, all other fields in the set will automatically be cleared.
#use_cases
def use_cases() -> ::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchUseCase>- (::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchUseCase>) — 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.
#use_cases=
def use_cases=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchUseCase>- value (::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchUseCase>) — 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.
- (::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchUseCase>) — 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.