- 2.85.0 (latest)
- 2.84.0
- 2.82.0
- 2.80.0
- 2.78.0
- 2.77.0
- 2.76.0
- 2.75.0
- 2.74.0
- 2.72.0
- 2.70.0
- 2.69.0
- 2.66.0
- 2.65.0
- 2.64.0
- 2.62.0
- 2.61.0
- 2.60.0
- 2.59.0
- 2.58.0
- 2.57.0
- 2.56.0
- 2.55.0
- 2.54.0
- 2.53.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.1
- 2.4.0
- 2.3.0
- 2.2.3
- 2.1.0
- 2.0.19
public static final class SearchRequest.BoostSpec.ConditionBoostSpec.Builder extends GeneratedMessage.Builder<SearchRequest.BoostSpec.ConditionBoostSpec.Builder> implements SearchRequest.BoostSpec.ConditionBoostSpecOrBuilderBoost applies to products which match a condition.
Protobuf type google.cloud.retail.v2beta.SearchRequest.BoostSpec.ConditionBoostSpec
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > SearchRequest.BoostSpec.ConditionBoostSpec.BuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public SearchRequest.BoostSpec.ConditionBoostSpec build()| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpec.ConditionBoostSpec |
|
buildPartial()
public SearchRequest.BoostSpec.ConditionBoostSpec buildPartial()| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpec.ConditionBoostSpec |
|
clear()
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder clear()| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpec.ConditionBoostSpec.Builder |
|
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;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpec.ConditionBoostSpec.Builder |
This builder for chaining. |
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;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpec.ConditionBoostSpec.Builder |
This builder for chaining. |
getBoost()
public float 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()| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpec.ConditionBoostSpec |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(SearchRequest.BoostSpec.ConditionBoostSpec other)
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder mergeFrom(SearchRequest.BoostSpec.ConditionBoostSpec other)| Parameter | |
|---|---|
| Name | Description |
other |
SearchRequest.BoostSpec.ConditionBoostSpec |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpec.ConditionBoostSpec.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpec.ConditionBoostSpec.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpec.ConditionBoostSpec.Builder |
|
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 |
floatThe boost to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpec.ConditionBoostSpec.Builder |
This builder for chaining. |
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 |
StringThe condition to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpec.ConditionBoostSpec.Builder |
This builder for chaining. |
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 |
ByteStringThe bytes for condition to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpec.ConditionBoostSpec.Builder |
This builder for chaining. |