Class SearchRequest.BoostSpec.ConditionBoostSpec.Builder (2.20.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.v2.SearchRequest.BoostSpec.ConditionBoostSpec

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchRequest.BoostSpec.ConditionBoostSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchRequest.BoostSpec.ConditionBoostSpec.Builder
Overrides

build()

public SearchRequest.BoostSpec.ConditionBoostSpec build()
Returns
TypeDescription
SearchRequest.BoostSpec.ConditionBoostSpec

buildPartial()

public SearchRequest.BoostSpec.ConditionBoostSpec buildPartial()
Returns
TypeDescription
SearchRequest.BoostSpec.ConditionBoostSpec

clear()

public SearchRequest.BoostSpec.ConditionBoostSpec.Builder clear()
Returns
TypeDescription
SearchRequest.BoostSpec.ConditionBoostSpec.Builder
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
TypeDescription
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
TypeDescription
SearchRequest.BoostSpec.ConditionBoostSpec.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public SearchRequest.BoostSpec.ConditionBoostSpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
SearchRequest.BoostSpec.ConditionBoostSpec.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchRequest.BoostSpec.ConditionBoostSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
SearchRequest.BoostSpec.ConditionBoostSpec.Builder
Overrides

clone()

public SearchRequest.BoostSpec.ConditionBoostSpec.Builder clone()
Returns
TypeDescription
SearchRequest.BoostSpec.ConditionBoostSpec.Builder
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for condition.

getDefaultInstanceForType()

public SearchRequest.BoostSpec.ConditionBoostSpec getDefaultInstanceForType()
Returns
TypeDescription
SearchRequest.BoostSpec.ConditionBoostSpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(SearchRequest.BoostSpec.ConditionBoostSpec other)

public SearchRequest.BoostSpec.ConditionBoostSpec.Builder mergeFrom(SearchRequest.BoostSpec.ConditionBoostSpec other)
Parameter
NameDescription
otherSearchRequest.BoostSpec.ConditionBoostSpec
Returns
TypeDescription
SearchRequest.BoostSpec.ConditionBoostSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchRequest.BoostSpec.ConditionBoostSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchRequest.BoostSpec.ConditionBoostSpec.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public SearchRequest.BoostSpec.ConditionBoostSpec.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
SearchRequest.BoostSpec.ConditionBoostSpec.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.BoostSpec.ConditionBoostSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchRequest.BoostSpec.ConditionBoostSpec.Builder
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
NameDescription
valuefloat

The boost to set.

Returns
TypeDescription
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
NameDescription
valueString

The condition to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for condition to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchRequest.BoostSpec.ConditionBoostSpec.Builder
Overrides

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

public SearchRequest.BoostSpec.ConditionBoostSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
SearchRequest.BoostSpec.ConditionBoostSpec.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.BoostSpec.ConditionBoostSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchRequest.BoostSpec.ConditionBoostSpec.Builder
Overrides