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.v2alpha.Rule.BoostAction
Static Fields
BOOST_FIELD_NUMBER
public static final int BOOST_FIELD_NUMBER
Field Value
PRODUCTS_FILTER_FIELD_NUMBER
public static final int PRODUCTS_FILTER_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Rule.BoostAction getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Rule.BoostAction.Builder newBuilder()
Returns
newBuilder(Rule.BoostAction prototype)
public static Rule.BoostAction.Builder newBuilder(Rule.BoostAction prototype)
Parameter
Returns
public static Rule.BoostAction parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Rule.BoostAction parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Rule.BoostAction parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Rule.BoostAction parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Rule.BoostAction parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Rule.BoostAction parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Rule.BoostAction parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Rule.BoostAction parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Rule.BoostAction parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Rule.BoostAction parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Rule.BoostAction parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Rule.BoostAction parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Rule.BoostAction> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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;
| Type | Description |
| float | The boost.
|
getDefaultInstanceForType()
public Rule.BoostAction getDefaultInstanceForType()
Returns
getParserForType()
public Parser<Rule.BoostAction> getParserForType()
Returns
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;
| 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;
| Type | Description |
| ByteString | The bytes for productsFilter.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Rule.BoostAction.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Rule.BoostAction.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Rule.BoostAction.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
