public sealed class Control.Types.BoostAction : IMessage<Control.Types.BoostAction>, IEquatable<Control.Types.BoostAction>, IDeepCloneable<Control.Types.BoostAction>, IBufferMessage, IMessage
Reference documentation and code samples for the Discovery Engine v1 API class Control.Types.BoostAction.
Required. Specifies which data store's documents can be boosted by this
control. Full data store name e.g.
projects/123/locations/global/collections/default_collection/dataStores/default_data_store
Required. Specifies which products to apply the boost to.
If no filter is provided all products will be boosted (No-op).
Syntax documentation:
https://cloud.google.com/retail/docs/filter-and-order
Maximum length is 5000 characters.
Otherwise an INVALID ARGUMENT error is thrown.
[[["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\u003eThe latest version of the \u003ccode\u003eControl.Types.BoostAction\u003c/code\u003e class in the Discovery Engine v1 API is 1.6.0, with previous versions ranging from 1.0.0-beta06 to 1.5.0 also available.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eControl.Types.BoostAction\u003c/code\u003e class adjusts the order of products in a returned list within the Discovery Engine.\u003c/p\u003e\n"],["\u003cp\u003eThis class 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.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eBoostAction\u003c/code\u003e class has properties for \u003ccode\u003eBoost\u003c/code\u003e (strength of the boost), \u003ccode\u003eDataStore\u003c/code\u003e (specific data store for boosting), and \u003ccode\u003eFilter\u003c/code\u003e (criteria for products to boost).\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eDataStoreAsDataStoreName\u003c/code\u003e property is a typed view over the \u003ccode\u003eDataStore\u003c/code\u003e property resource name.\u003c/p\u003e\n"]]],[],null,["# Discovery Engine v1 API - Class Control.Types.BoostAction (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.Types.BoostAction)\n- [1.8.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.8.0/Google.Cloud.DiscoveryEngine.V1.Control.Types.BoostAction)\n- [1.7.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.7.0/Google.Cloud.DiscoveryEngine.V1.Control.Types.BoostAction)\n- [1.6.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.6.0/Google.Cloud.DiscoveryEngine.V1.Control.Types.BoostAction)\n- [1.5.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.5.0/Google.Cloud.DiscoveryEngine.V1.Control.Types.BoostAction)\n- [1.4.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.4.0/Google.Cloud.DiscoveryEngine.V1.Control.Types.BoostAction)\n- [1.3.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.3.0/Google.Cloud.DiscoveryEngine.V1.Control.Types.BoostAction)\n- [1.2.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.2.0/Google.Cloud.DiscoveryEngine.V1.Control.Types.BoostAction)\n- [1.1.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.1.0/Google.Cloud.DiscoveryEngine.V1.Control.Types.BoostAction)\n- [1.0.0-beta06](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.0.0-beta06/Google.Cloud.DiscoveryEngine.V1.Control.Types.BoostAction) \n\n public sealed class Control.Types.BoostAction : IMessage\u003cControl.Types.BoostAction\u003e, IEquatable\u003cControl.Types.BoostAction\u003e, IDeepCloneable\u003cControl.Types.BoostAction\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Discovery Engine v1 API class Control.Types.BoostAction.\n\nAdjusts order of products in returned list. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e Control.Types.BoostAction \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)[Types](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.Control.Types)[BoostAction](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.Control.Types.BoostAction), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[Control](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.Control)[Types](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.Control.Types)[BoostAction](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.Control.Types.BoostAction), [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)[Types](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.Control.Types)[BoostAction](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.Control.Types.BoostAction), [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### BoostAction()\n\n public BoostAction()\n\n### BoostAction(BoostAction)\n\n public BoostAction(Control.Types.BoostAction other)\n\nProperties\n----------\n\n### Boost\n\n [Obsolete]\n public float Boost { get; set; }\n\nStrength of the boost, which should be in \\[-1, 1\\]. Negative\nboost means demotion. Default is 0.0 (No-op).\n\n### BoostSpecCase\n\n public Control.Types.BoostAction.BoostSpecOneofCase BoostSpecCase { get; }\n\n### DataStore\n\n public string DataStore { get; set; }\n\nRequired. Specifies which data store's documents can be boosted by this\ncontrol. Full data store name e.g.\nprojects/123/locations/global/collections/default_collection/dataStores/default_data_store\n\n### DataStoreAsDataStoreName\n\n public DataStoreName DataStoreAsDataStoreName { get; set; }\n\n[DataStoreName](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.DataStoreName)-typed view over the [DataStore](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.Control.Types.BoostAction#Google_Cloud_DiscoveryEngine_V1_Control_Types_BoostAction_DataStore) resource name property.\n\n### Filter\n\n public string Filter { get; set; }\n\nRequired. Specifies which products to apply the boost to.\n\nIf no filter is provided all products will be boosted (No-op).\nSyntax documentation:\n\u003chttps://cloud.google.com/retail/docs/filter-and-order\u003e\nMaximum length is 5000 characters.\nOtherwise an INVALID ARGUMENT error is thrown.\n\n### FixedBoost\n\n public float FixedBoost { get; set; }\n\nOptional. Strength of the boost, which should be in \\[-1, 1\\]. Negative\nboost means demotion. Default is 0.0 (No-op).\n\n### HasFixedBoost\n\n public bool HasFixedBoost { get; }\n\nGets whether the \"fixed_boost\" field is set\n\n### InterpolationBoostSpec\n\n public Control.Types.BoostAction.Types.InterpolationBoostSpec InterpolationBoostSpec { get; set; }\n\nOptional. Complex specification for custom ranking based on customer\ndefined attribute value."]]
