public static final class Rule.BoostAction.Builder extends GeneratedMessageV3.Builder<Rule.BoostAction.Builder> implements Rule.BoostActionOrBuilderA boost action to apply to results matching condition specified above.
Protobuf type google.cloud.retail.v2alpha.Rule.BoostAction
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Rule.BoostAction.BuilderImplements
Rule.BoostActionOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Rule.BoostAction.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Rule.BoostAction.Builder | |
build()
public Rule.BoostAction build()| Returns | |
|---|---|
| Type | Description |
Rule.BoostAction | |
buildPartial()
public Rule.BoostAction buildPartial()| Returns | |
|---|---|
| Type | Description |
Rule.BoostAction | |
clear()
public Rule.BoostAction.Builder clear()| Returns | |
|---|---|
| Type | Description |
Rule.BoostAction.Builder | |
clearBoost()
public Rule.BoostAction.Builder clearBoost()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 |
Rule.BoostAction.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Rule.BoostAction.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Rule.BoostAction.Builder | |
clearOneof(Descriptors.OneofDescriptor oneof)
public Rule.BoostAction.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Rule.BoostAction.Builder | |
clearProductsFilter()
public Rule.BoostAction.Builder clearProductsFilter()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 |
Rule.BoostAction.Builder | This builder for chaining. |
clone()
public Rule.BoostAction.Builder clone()| Returns | |
|---|---|
| Type | Description |
Rule.BoostAction.Builder | |
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 | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(Rule.BoostAction other)
public Rule.BoostAction.Builder mergeFrom(Rule.BoostAction other)| Parameter | |
|---|---|
| Name | Description |
other | Rule.BoostAction |
| Returns | |
|---|---|
| Type | Description |
Rule.BoostAction.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Rule.BoostAction.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Rule.BoostAction.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public Rule.BoostAction.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
Rule.BoostAction.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Rule.BoostAction.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Rule.BoostAction.Builder | |
setBoost(float value)
public Rule.BoostAction.Builder setBoost(float value)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;
| Parameter | |
|---|---|
| Name | Description |
value | floatThe boost to set. |
| Returns | |
|---|---|
| Type | Description |
Rule.BoostAction.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Rule.BoostAction.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Rule.BoostAction.Builder | |
setProductsFilter(String value)
public Rule.BoostAction.Builder setProductsFilter(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe productsFilter to set. |
| Returns | |
|---|---|
| Type | Description |
Rule.BoostAction.Builder | This builder for chaining. |
setProductsFilterBytes(ByteString value)
public Rule.BoostAction.Builder setProductsFilterBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for productsFilter to set. |
| Returns | |
|---|---|
| Type | Description |
Rule.BoostAction.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Rule.BoostAction.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Rule.BoostAction.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final Rule.BoostAction.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Rule.BoostAction.Builder | |