Discovery Engine v1 API - Class Control (1.5.0)

public sealed class Control : IMessage<Control>, IEquatable<Control>, IDeepCloneable<Control>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1 API class 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.

Inheritance

object > Control

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

Control()

public Control()

Control(Control)

public Control(Control other)
Parameter
Name Description
other Control

Properties

ActionCase

public Control.ActionOneofCase ActionCase { get; }
Property Value
Type Description
ControlActionOneofCase

AssociatedServingConfigIds

public RepeatedField<string> AssociatedServingConfigIds { get; }

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.

Property Value
Type Description
RepeatedFieldstring

BoostAction

public Control.Types.BoostAction BoostAction { get; set; }

Defines a boost-type control

Property Value
Type Description
ControlTypesBoostAction

Conditions

public RepeatedField<Condition> Conditions { get; }

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.

Property Value
Type Description
RepeatedFieldCondition

ControlName

public ControlName ControlName { get; set; }

ControlName-typed view over the Name resource name property.

Property Value
Type Description
ControlName

DisplayName

public string DisplayName { get; set; }

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.

Property Value
Type Description
string

FilterAction

public Control.Types.FilterAction FilterAction { get; set; }

Defines a filter-type control Currently not supported by Recommendation

Property Value
Type Description
ControlTypesFilterAction

Name

public string Name { get; set; }

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

Property Value
Type Description
string

RedirectAction

public Control.Types.RedirectAction RedirectAction { get; set; }

Defines a redirect-type control.

Property Value
Type Description
ControlTypesRedirectAction

SolutionType

public SolutionType SolutionType { get; set; }

Required. Immutable. What solution the control belongs to.

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

Property Value
Type Description
SolutionType

SynonymsAction

public Control.Types.SynonymsAction SynonymsAction { get; set; }

Treats a group of terms as synonyms of one another.

Property Value
Type Description
ControlTypesSynonymsAction

UseCases

public RepeatedField<SearchUseCase> UseCases { get; }

Specifies the use case for the control. Affects what condition fields can be set. Only applies to [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_SEARCH]. Currently only allow one use case per control. Must be set when solution_type is [SolutionType.SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_SEARCH].

Property Value
Type Description
RepeatedFieldSearchUseCase