Class SearchRequest.BoostSpec.ConditionBoostSpec.Builder (2.44.0)

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.v2alpha.SearchRequest.BoostSpec.ConditionBoostSpec

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
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()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchRequest.BoostSpec.ConditionBoostSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
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;

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.

clearField(Descriptors.FieldDescriptor field)

public SearchRequest.BoostSpec.ConditionBoostSpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchRequest.BoostSpec.ConditionBoostSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Overrides

clone()

public SearchRequest.BoostSpec.ConditionBoostSpec.Builder clone()
Overrides

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()

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SearchRequest.BoostSpec.ConditionBoostSpec other)

public SearchRequest.BoostSpec.ConditionBoostSpec.Builder mergeFrom(SearchRequest.BoostSpec.ConditionBoostSpec other)
Parameter
Name Description
other SearchRequest.BoostSpec.ConditionBoostSpec

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchRequest.BoostSpec.ConditionBoostSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Overrides
Exceptions
Type Description
IOException

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)
Parameter
Name Description
unknownFields UnknownFieldSet
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.

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 String

The 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 ByteString

The bytes for condition to set.

Returns
Type Description
SearchRequest.BoostSpec.ConditionBoostSpec.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public SearchRequest.BoostSpec.ConditionBoostSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SearchRequest.BoostSpec.ConditionBoostSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.BoostSpec.ConditionBoostSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Overrides