Send feedback
Class Control.BoostAction (0.74.0)
Version latestkeyboard_arrow_down
public static final class Control . BoostAction extends GeneratedMessageV3 implements Control . BoostActionOrBuilder
Adjusts order of products in returned list.
Protobuf type google.cloud.discoveryengine.v1.Control.BoostAction
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
BOOST_FIELD_NUMBER
public static final int BOOST_FIELD_NUMBER
Field Value
Type Description
int
DATA_STORE_FIELD_NUMBER
public static final int DATA_STORE_FIELD_NUMBER
Field Value
Type Description
int
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int
FIXED_BOOST_FIELD_NUMBER
public static final int FIXED_BOOST_FIELD_NUMBER
Field Value
Type Description
int
INTERPOLATION_BOOST_SPEC_FIELD_NUMBER
public static final int INTERPOLATION_BOOST_SPEC_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static Control . BoostAction getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static Control . BoostAction . Builder newBuilder ()
newBuilder(Control.BoostAction prototype)
public static Control . BoostAction . Builder newBuilder ( Control . BoostAction prototype )
public static Control . BoostAction parseDelimitedFrom ( InputStream input )
public static Control . BoostAction parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static Control . BoostAction parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Control . BoostAction parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static Control . BoostAction parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Control . BoostAction parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static Control . BoostAction parseFrom ( CodedInputStream input )
public static Control . BoostAction parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static Control . BoostAction parseFrom ( InputStream input )
public static Control . BoostAction parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static Control . BoostAction parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Control . BoostAction parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<Control . BoostAction > parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getBoost() (deprecated)
Deprecated. google.cloud.discoveryengine.v1.Control.BoostAction.boost is deprecated. See
google/cloud/discoveryengine/v1/control.proto;l=187
Strength of the boost, which should be in [-1, 1]. Negative
boost means demotion. Default is 0.0 (No-op).
float boost = 1 [deprecated = true];
Returns
Type Description
float The boost.
getBoostSpecCase()
public Control . BoostAction . BoostSpecCase getBoostSpecCase ()
getDataStore()
public String getDataStore ()
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
string data_store = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns
Type Description
String The dataStore.
getDataStoreBytes()
public ByteString getDataStoreBytes ()
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
string data_store = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns
Type Description
ByteString The bytes for dataStore.
getDefaultInstanceForType()
public Control . BoostAction getDefaultInstanceForType ()
getFilter()
public String getFilter ()
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.
string filter = 2 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
String The filter.
getFilterBytes()
public ByteString getFilterBytes ()
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.
string filter = 2 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
ByteString The bytes for filter.
getFixedBoost()
public float getFixedBoost ()
Optional. Strength of the boost, which should be in [-1, 1]. Negative
boost means demotion. Default is 0.0 (No-op).
float fixed_boost = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
float The fixedBoost.
getInterpolationBoostSpec()
public Control . BoostAction . InterpolationBoostSpec getInterpolationBoostSpec ()
Optional. Complex specification for custom ranking based on customer
defined attribute value.
.google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec interpolation_boost_spec = 5 [(.google.api.field_behavior) = OPTIONAL];
getInterpolationBoostSpecOrBuilder()
public Control . BoostAction . InterpolationBoostSpecOrBuilder getInterpolationBoostSpecOrBuilder ()
Optional. Complex specification for custom ranking based on customer
defined attribute value.
.google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec interpolation_boost_spec = 5 [(.google.api.field_behavior) = OPTIONAL];
getParserForType()
public Parser<Control . BoostAction > getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
hasFixedBoost()
public boolean hasFixedBoost ()
Optional. Strength of the boost, which should be in [-1, 1]. Negative
boost means demotion. Default is 0.0 (No-op).
float fixed_boost = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
boolean Whether the fixedBoost field is set.
hasInterpolationBoostSpec()
public boolean hasInterpolationBoostSpec ()
Optional. Complex specification for custom ranking based on customer
defined attribute value.
.google.cloud.discoveryengine.v1.Control.BoostAction.InterpolationBoostSpec interpolation_boost_spec = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
boolean Whether the interpolationBoostSpec field is set.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public Control . BoostAction . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Control . BoostAction . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public Control . BoostAction . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-29 UTC.
Need to tell us more?
[[["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-10-29 UTC."],[],[]]
