Class Rule.BoostAction (2.47.0) 

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.v2.Rule.BoostAction

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Rule.BoostAction

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()
Returns
Type Description
Rule.BoostAction

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Rule.BoostAction.Builder newBuilder()
Returns
Type Description
Rule.BoostAction.Builder

newBuilder(Rule.BoostAction prototype)

public static Rule.BoostAction.Builder newBuilder(Rule.BoostAction prototype)
Parameter
Name Description
prototype Rule.BoostAction
Returns
Type Description
Rule.BoostAction.Builder

parseDelimitedFrom(InputStream input)

public static Rule.BoostAction parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Rule.BoostAction
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Rule.BoostAction parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Rule.BoostAction
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Rule.BoostAction parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Rule.BoostAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Rule.BoostAction parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Rule.BoostAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Rule.BoostAction parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Rule.BoostAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Rule.BoostAction parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Rule.BoostAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Rule.BoostAction parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Rule.BoostAction
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Rule.BoostAction parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Rule.BoostAction
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Rule.BoostAction parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Rule.BoostAction
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Rule.BoostAction parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Rule.BoostAction
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Rule.BoostAction parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Rule.BoostAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Rule.BoostAction parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Rule.BoostAction
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Rule.BoostAction> parser()
Returns
Type Description
Parser<BoostAction>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBoost()

public float 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()
Returns
Type Description
Rule.BoostAction

getParserForType()

public Parser<Rule.BoostAction> getParserForType()
Returns
Type Description
Parser<BoostAction>
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()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Rule.BoostAction.Builder newBuilderForType()
Returns
Type Description
Rule.BoostAction.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Rule.BoostAction.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Rule.BoostAction.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Rule.BoostAction.Builder toBuilder()
Returns
Type Description
Rule.BoostAction.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException