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.
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.
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].
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[[["\u003cp\u003eThis page provides documentation for the \u003ccode\u003eControl\u003c/code\u003e class within the Google Cloud Discovery Engine v1 API, outlining its role in defining conditioned behaviors for serving.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eControl\u003c/code\u003e class, which is part of the \u003ccode\u003eGoogle.Cloud.DiscoveryEngine.V1\u003c/code\u003e namespace, implements several interfaces including \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e, and inherits from \u003ccode\u003eobject\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eControl\u003c/code\u003e instances define actions such as boosting, filtering, redirecting, or managing synonyms, and are associated with ServingConfigs to influence serving time behavior.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version of \u003ccode\u003eControl\u003c/code\u003e is 1.6.0, and documentation is also available for previous versions ranging from 1.5.0 to 1.0.0-beta06, allowing for comparisons and historical reference.\u003c/p\u003e\n"],["\u003cp\u003eThe page details various properties of the \u003ccode\u003eControl\u003c/code\u003e class, including \u003ccode\u003eBoostAction\u003c/code\u003e, \u003ccode\u003eFilterAction\u003c/code\u003e, \u003ccode\u003eRedirectAction\u003c/code\u003e, \u003ccode\u003eSynonymsAction\u003c/code\u003e, and more, which allow control over the behaviour.\u003c/p\u003e\n"]]],[],null,["# Discovery Engine v1 API - Class Control (1.9.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.9.0 (latest)](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.Control)\n- [1.8.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.8.0/Google.Cloud.DiscoveryEngine.V1.Control)\n- [1.7.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.7.0/Google.Cloud.DiscoveryEngine.V1.Control)\n- [1.6.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.6.0/Google.Cloud.DiscoveryEngine.V1.Control)\n- [1.5.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.5.0/Google.Cloud.DiscoveryEngine.V1.Control)\n- [1.4.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.4.0/Google.Cloud.DiscoveryEngine.V1.Control)\n- [1.3.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.3.0/Google.Cloud.DiscoveryEngine.V1.Control)\n- [1.2.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.2.0/Google.Cloud.DiscoveryEngine.V1.Control)\n- [1.1.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.1.0/Google.Cloud.DiscoveryEngine.V1.Control)\n- [1.0.0-beta06](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.0.0-beta06/Google.Cloud.DiscoveryEngine.V1.Control) \n\n public sealed class Control : IMessage\u003cControl\u003e, IEquatable\u003cControl\u003e, IDeepCloneable\u003cControl\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Discovery Engine v1 API class Control.\n\nDefines a conditioned behavior to employ during serving.\nMust be attached to a\n\\[ServingConfig\\]\\[google.cloud.discoveryengine.v1.ServingConfig\\] to be\nconsidered at serving time. Permitted actions dependent on `SolutionType`. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e Control \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[Control](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.Control), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[Control](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.Control), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[Control](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.Control), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.DiscoveryEngine.V1](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1)\n\nAssembly\n--------\n\nGoogle.Cloud.DiscoveryEngine.V1.dll\n\nConstructors\n------------\n\n### Control()\n\n public Control()\n\n### Control(Control)\n\n public Control(Control other)\n\nProperties\n----------\n\n### ActionCase\n\n public Control.ActionOneofCase ActionCase { get; }\n\n### AssociatedServingConfigIds\n\n public RepeatedField\u003cstring\u003e AssociatedServingConfigIds { get; }\n\nOutput only. List of all\n\\[ServingConfig\\]\\[google.cloud.discoveryengine.v1.ServingConfig\\] IDs this\ncontrol is attached to. May take up to 10 minutes to update after changes.\n\n### BoostAction\n\n public Control.Types.BoostAction BoostAction { get; set; }\n\nDefines a boost-type control\n\n### Conditions\n\n public RepeatedField\u003cCondition\u003e Conditions { get; }\n\nDetermines when the associated action will trigger.\n\nOmit to always apply the action.\nCurrently only a single condition may be specified.\nOtherwise an INVALID ARGUMENT error is thrown.\n\n### ControlName\n\n public ControlName ControlName { get; set; }\n\n[ControlName](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.ControlName)-typed view over the [Name](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.Control#Google_Cloud_DiscoveryEngine_V1_Control_Name) resource name property.\n\n### DisplayName\n\n public string DisplayName { get; set; }\n\nRequired. Human readable name. The identifier used in UI views.\n\nMust be UTF-8 encoded string. Length limit is 128 characters.\nOtherwise an INVALID ARGUMENT error is thrown.\n\n### FilterAction\n\n public Control.Types.FilterAction FilterAction { get; set; }\n\nDefines a filter-type control\nCurrently not supported by Recommendation\n\n### Name\n\n public string Name { get; set; }\n\nImmutable. Fully qualified name\n`projects/*/locations/global/dataStore/*/controls/*`\n\n### PromoteAction\n\n public Control.Types.PromoteAction PromoteAction { get; set; }\n\nPromote certain links based on predefined trigger queries.\n\n### RedirectAction\n\n public Control.Types.RedirectAction RedirectAction { get; set; }\n\nDefines a redirect-type control.\n\n### SolutionType\n\n public SolutionType SolutionType { get; set; }\n\nRequired. Immutable. What solution the control belongs to.\n\nMust be compatible with vertical of resource.\nOtherwise an INVALID ARGUMENT error is thrown.\n\n### SynonymsAction\n\n public Control.Types.SynonymsAction SynonymsAction { get; set; }\n\nTreats a group of terms as synonyms of one another.\n\n### UseCases\n\n public RepeatedField\u003cSearchUseCase\u003e UseCases { get; }\n\nSpecifies the use case for the control.\nAffects what condition fields can be set.\nOnly applies to\n\\[SOLUTION_TYPE_SEARCH\\]\\[google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_SEARCH\\].\nCurrently only allow one use case per control.\nMust be set when solution_type is\n\\[SolutionType.SOLUTION_TYPE_SEARCH\\]\\[google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_SEARCH\\]."]]
