Send feedback
Class Rule.BoostAction (2.33.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.33.0 keyboard_arrow_down
public static final class Rule . BoostAction extends GeneratedMessageV3 implements Rule . BoostActionOrBuilder
A boost action to apply to results matching condition specified above.
Protobuf type google.cloud.retail.v2beta.Rule.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
PRODUCTS_FILTER_FIELD_NUMBER
public static final int PRODUCTS_FILTER_FIELD_NUMBER
Field Value Type Description int
Static Methods
getDefaultInstance()
public static Rule . BoostAction getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static Rule . BoostAction . Builder newBuilder ()
newBuilder(Rule.BoostAction prototype)
public static Rule . BoostAction . Builder newBuilder ( Rule . BoostAction prototype )
public static Rule . BoostAction parseDelimitedFrom ( InputStream input )
public static Rule . BoostAction parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static Rule . BoostAction parseFrom ( byte [] data )
Parameter Name Description data
byte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Rule . BoostAction parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static Rule . BoostAction parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Rule . BoostAction parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static Rule . BoostAction parseFrom ( CodedInputStream input )
public static Rule . BoostAction parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static Rule . BoostAction parseFrom ( InputStream input )
public static Rule . BoostAction parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static Rule . BoostAction parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Rule . BoostAction parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<Rule . BoostAction> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter Name Description obj
Object
Overrides
getBoost()
Strength of the condition boost, which must be in [-1, 1]. Negative
boost means demotion. Default is 0.0.
Setting to 1.0 gives the item a big promotion. However, it does not
necessarily mean that the boosted item will be the top result at all
times, nor that other items will be excluded. Results could still be
shown even when none of them matches the condition. And results that
are significantly more relevant to the search query can still trump
your heavily favored but irrelevant items.
Setting to -1.0 gives the item a big demotion. However, results that
are deeply relevant might still be shown. The item will have an
upstream battle to get a fairly high ranking, but it is not blocked out
completely.
Setting to 0.0 means no boost applied. The boosting condition is
ignored.
float boost = 1;
Returns Type Description float
The boost.
getDefaultInstanceForType()
public Rule . BoostAction getDefaultInstanceForType ()
getParserForType()
public Parser<Rule . BoostAction> getParserForType ()
Overrides
getProductsFilter()
public String getProductsFilter ()
The filter can have a max size of 5000 characters.
An expression which specifies which products to apply an action to.
The syntax and supported fields are the same as a filter expression. See
SearchRequest.filter
for detail syntax and limitations.
Examples:
To boost products with product ID "product_1" or "product_2", and
color
"Red" or "Blue":<br>
(id: ANY("product_1", "product_2"))<br>
AND<br>
(colorFamilies: ANY("Red", "Blue"))<br>
string products_filter = 2;
Returns Type Description String
The productsFilter.
getProductsFilterBytes()
public ByteString getProductsFilterBytes ()
The filter can have a max size of 5000 characters.
An expression which specifies which products to apply an action to.
The syntax and supported fields are the same as a filter expression. See
SearchRequest.filter
for detail syntax and limitations.
Examples:
To boost products with product ID "product_1" or "product_2", and
color
"Red" or "Blue":<br>
(id: ANY("product_1", "product_2"))<br>
AND<br>
(colorFamilies: ANY("Red", "Blue"))<br>
string products_filter = 2;
Returns Type Description ByteString
The bytes for productsFilter.
getSerializedSize()
public int getSerializedSize ()
Returns Type Description int
Overrides
hashCode()
Returns Type Description int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public Rule . BoostAction . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Rule . BoostAction . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Overrides
toBuilder()
public Rule . 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 2024-10-04 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
Need to tell us more?
{"lastModified": "Last updated 2024-10-04 UTC."}
[[["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 2024-10-04 UTC."]]