Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::Control (v0.14.1)

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

#boost_action=

def boost_action=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::Control::BoostAction
Parameter
Returns

#conditions

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

#conditions=

def conditions=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1beta::Condition>
Parameter
  • 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.

Returns

#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::V1beta::Control::FilterAction
Returns

#filter_action=

def filter_action=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::Control::FilterAction
Parameter
Returns

#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::V1beta::Control::RedirectAction
Returns

#redirect_action=

def redirect_action=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::Control::RedirectAction
Parameter
Returns

#solution_type

def solution_type() -> ::Google::Cloud::DiscoveryEngine::V1beta::SolutionType
Returns

#solution_type=

def solution_type=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::SolutionType
Parameter
Returns

#synonyms_action

def synonyms_action() -> ::Google::Cloud::DiscoveryEngine::V1beta::Control::SynonymsAction
Returns

#synonyms_action=

def synonyms_action=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::Control::SynonymsAction
Parameter
Returns

#use_cases

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

#use_cases=

def use_cases=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchUseCase>
Parameter
Returns