Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::Control (v1.4.0)

Version latest

• 1.4.0 (latest)
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.2
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.2
• 0.3.0
• 0.2.0
• 0.1.0

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::Control.

Defines a conditioned behavior to employ during serving. Must be attached to a [ServingConfig][google.cloud.discoveryengine.v1.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>

Returns

• (::Array<::String>) — Output only. List of all [ServingConfig][google.cloud.discoveryengine.v1.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::V1::Control::BoostAction

Returns

• (::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction) — Defines a boost-type control

#boost_action=

def boost_action=(value) -> ::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction

Parameter

• value (::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction) — Defines a boost-type control

Returns

• (::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction) — Defines a boost-type control

#conditions

def conditions() -> ::Array<::Google::Cloud::DiscoveryEngine::V1::Condition>

Returns

• (::Array<::Google::Cloud::DiscoveryEngine::V1::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::V1::Condition>

Parameter

• value (::Array<::Google::Cloud::DiscoveryEngine::V1::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.

Returns

• (::Array<::Google::Cloud::DiscoveryEngine::V1::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

Returns

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

Parameter

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

Returns

• (::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::V1::Control::FilterAction

Returns

• (::Google::Cloud::DiscoveryEngine::V1::Control::FilterAction) — Defines a filter-type control Currently not supported by Recommendation

#filter_action=

def filter_action=(value) -> ::Google::Cloud::DiscoveryEngine::V1::Control::FilterAction

Parameter

• value (::Google::Cloud::DiscoveryEngine::V1::Control::FilterAction) — Defines a filter-type control Currently not supported by Recommendation

Returns

• (::Google::Cloud::DiscoveryEngine::V1::Control::FilterAction) — Defines a filter-type control Currently not supported by Recommendation

#name

def name() -> ::String

Returns

• (::String) — Immutable. Fully qualified name projects/*/locations/global/dataStore/*/controls/*

#name=

def name=(value) -> ::String

Parameter

• value (::String) — Immutable. Fully qualified name projects/*/locations/global/dataStore/*/controls/*

Returns

• (::String) — Immutable. Fully qualified name projects/*/locations/global/dataStore/*/controls/*

#redirect_action

def redirect_action() -> ::Google::Cloud::DiscoveryEngine::V1::Control::RedirectAction

Returns

• (::Google::Cloud::DiscoveryEngine::V1::Control::RedirectAction) — Defines a redirect-type control.

#redirect_action=

def redirect_action=(value) -> ::Google::Cloud::DiscoveryEngine::V1::Control::RedirectAction

Parameter

• value (::Google::Cloud::DiscoveryEngine::V1::Control::RedirectAction) — Defines a redirect-type control.

Returns

• (::Google::Cloud::DiscoveryEngine::V1::Control::RedirectAction) — Defines a redirect-type control.

#solution_type

def solution_type() -> ::Google::Cloud::DiscoveryEngine::V1::SolutionType

Returns

• (::Google::Cloud::DiscoveryEngine::V1::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::V1::SolutionType

Parameter

• value (::Google::Cloud::DiscoveryEngine::V1::SolutionType) — Required. Immutable. What solution the control belongs to.

  Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.

Returns

• (::Google::Cloud::DiscoveryEngine::V1::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::V1::Control::SynonymsAction

Returns

• (::Google::Cloud::DiscoveryEngine::V1::Control::SynonymsAction) — Treats a group of terms as synonyms of one another.

#synonyms_action=

def synonyms_action=(value) -> ::Google::Cloud::DiscoveryEngine::V1::Control::SynonymsAction

Parameter

• value (::Google::Cloud::DiscoveryEngine::V1::Control::SynonymsAction) — Treats a group of terms as synonyms of one another.

Returns

• (::Google::Cloud::DiscoveryEngine::V1::Control::SynonymsAction) — Treats a group of terms as synonyms of one another.

#use_cases

def use_cases() -> ::Array<::Google::Cloud::DiscoveryEngine::V1::SearchUseCase>

Returns

• (::Array<::Google::Cloud::DiscoveryEngine::V1::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::V1::SearchUseCase>

Parameter

• value (::Array<::Google::Cloud::DiscoveryEngine::V1::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.

Returns

• (::Array<::Google::Cloud::DiscoveryEngine::V1::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.