public static final class SearchRequest.BoostSpec.ConditionBoostSpec.Builder extends GeneratedMessageV3.Builder<SearchRequest.BoostSpec.ConditionBoostSpec.Builder> implements SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder
Boost applies to products which match a condition.
Protobuf type google.cloud.retail.v2beta.SearchRequest.BoostSpec.ConditionBoostSpec
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public SearchRequest.BoostSpec.ConditionBoostSpec build()
buildPartial()
public SearchRequest.BoostSpec.ConditionBoostSpec buildPartial()
clear()
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder clear()
Overrides
clearBoost()
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder clearBoost()
Strength of the condition boost, which should 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 = 2;
clearCondition()
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder clearCondition()
An expression which specifies a boost condition. 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":
- (id: ANY("product_1", "product_2")) AND (colorFamilies:
ANY("Red","Blue"))
string condition = 1;
clearField(Descriptors.FieldDescriptor field)
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clone()
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder clone()
Overrides
getBoost()
Strength of the condition boost, which should 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 = 2;
| Returns |
|---|
| Type | Description |
float | The boost.
|
getCondition()
public String getCondition()
An expression which specifies a boost condition. 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":
- (id: ANY("product_1", "product_2")) AND (colorFamilies:
ANY("Red","Blue"))
string condition = 1;
| Returns |
|---|
| Type | Description |
String | The condition.
|
getConditionBytes()
public ByteString getConditionBytes()
An expression which specifies a boost condition. 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":
- (id: ANY("product_1", "product_2")) AND (colorFamilies:
ANY("Red","Blue"))
string condition = 1;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for condition.
|
getDefaultInstanceForType()
public SearchRequest.BoostSpec.ConditionBoostSpec getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(SearchRequest.BoostSpec.ConditionBoostSpec other)
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder mergeFrom(SearchRequest.BoostSpec.ConditionBoostSpec other)
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder mergeFrom(Message other)
| Parameter |
|---|
| Name | Description |
other | Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SearchRequest.BoostSpec.ConditionBoostSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
setBoost(float value)
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder setBoost(float value)
Strength of the condition boost, which should 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 = 2;
| Parameter |
|---|
| Name | Description |
value | float
The boost to set.
|
setCondition(String value)
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder setCondition(String value)
An expression which specifies a boost condition. 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":
- (id: ANY("product_1", "product_2")) AND (colorFamilies:
ANY("Red","Blue"))
string condition = 1;
| Parameter |
|---|
| Name | Description |
value | String
The condition to set.
|
setConditionBytes(ByteString value)
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder setConditionBytes(ByteString value)
An expression which specifies a boost condition. 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":
- (id: ANY("product_1", "product_2")) AND (colorFamilies:
ANY("Red","Blue"))
string condition = 1;
| Parameter |
|---|
| Name | Description |
value | ByteString
The bytes for condition to set.
|
setField(Descriptors.FieldDescriptor field, Object value)
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final SearchRequest.BoostSpec.ConditionBoostSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
