Class SearchRequest.BoostSpec (2.57.0) 

public static final class SearchRequest.BoostSpec extends GeneratedMessageV3 implements SearchRequest.BoostSpecOrBuilder

Boost specification to boost certain items.

Protobuf type google.cloud.retail.v2.SearchRequest.BoostSpec

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SearchRequest.BoostSpec

Static Fields

CONDITION_BOOST_SPECS_FIELD_NUMBER

public static final int CONDITION_BOOST_SPECS_FIELD_NUMBER
Field Value
Type Description
int

SKIP_BOOST_SPEC_VALIDATION_FIELD_NUMBER

public static final int SKIP_BOOST_SPEC_VALIDATION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchRequest.BoostSpec getDefaultInstance()
Returns
Type Description
SearchRequest.BoostSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SearchRequest.BoostSpec.Builder newBuilder()
Returns
Type Description
SearchRequest.BoostSpec.Builder

newBuilder(SearchRequest.BoostSpec prototype)

public static SearchRequest.BoostSpec.Builder newBuilder(SearchRequest.BoostSpec prototype)
Parameter
Name Description
prototype SearchRequest.BoostSpec
Returns
Type Description
SearchRequest.BoostSpec.Builder

parseDelimitedFrom(InputStream input)

public static SearchRequest.BoostSpec parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchRequest.BoostSpec
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.BoostSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.BoostSpec
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SearchRequest.BoostSpec parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SearchRequest.BoostSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.BoostSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.BoostSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchRequest.BoostSpec parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchRequest.BoostSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.BoostSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.BoostSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchRequest.BoostSpec parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchRequest.BoostSpec
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.BoostSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.BoostSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SearchRequest.BoostSpec parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchRequest.BoostSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.BoostSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.BoostSpec
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SearchRequest.BoostSpec parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchRequest.BoostSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.BoostSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.BoostSpec
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SearchRequest.BoostSpec> parser()
Returns
Type Description
Parser<BoostSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getConditionBoostSpecs(int index)

public SearchRequest.BoostSpec.ConditionBoostSpec getConditionBoostSpecs(int index)

Condition boost specifications. If a product matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.

repeated .google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec condition_boost_specs = 1;

Parameter
Name Description
index int
Returns
Type Description
SearchRequest.BoostSpec.ConditionBoostSpec

getConditionBoostSpecsCount()

public int getConditionBoostSpecsCount()

Condition boost specifications. If a product matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.

repeated .google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec condition_boost_specs = 1;

Returns
Type Description
int

getConditionBoostSpecsList()

public List<SearchRequest.BoostSpec.ConditionBoostSpec> getConditionBoostSpecsList()

Condition boost specifications. If a product matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.

repeated .google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec condition_boost_specs = 1;

Returns
Type Description
List<ConditionBoostSpec>

getConditionBoostSpecsOrBuilder(int index)

public SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder getConditionBoostSpecsOrBuilder(int index)

Condition boost specifications. If a product matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.

repeated .google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec condition_boost_specs = 1;

Parameter
Name Description
index int
Returns
Type Description
SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder

getConditionBoostSpecsOrBuilderList()

public List<? extends SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder> getConditionBoostSpecsOrBuilderList()

Condition boost specifications. If a product matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.

repeated .google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec condition_boost_specs = 1;

Returns
Type Description
List<? extends com.google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder>

getDefaultInstanceForType()

public SearchRequest.BoostSpec getDefaultInstanceForType()
Returns
Type Description
SearchRequest.BoostSpec

getParserForType()

public Parser<SearchRequest.BoostSpec> getParserForType()
Returns
Type Description
Parser<BoostSpec>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSkipBoostSpecValidation()

public boolean getSkipBoostSpecValidation()

Whether to skip boostspec validation. If this field is set to true, invalid BoostSpec.condition_boost_specs will be ignored and valid BoostSpec.condition_boost_specs will still be applied.

optional bool skip_boost_spec_validation = 2;

Returns
Type Description
boolean

The skipBoostSpecValidation.

hasSkipBoostSpecValidation()

public boolean hasSkipBoostSpecValidation()

Whether to skip boostspec validation. If this field is set to true, invalid BoostSpec.condition_boost_specs will be ignored and valid BoostSpec.condition_boost_specs will still be applied.

optional bool skip_boost_spec_validation = 2;

Returns
Type Description
boolean

Whether the skipBoostSpecValidation field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SearchRequest.BoostSpec.Builder newBuilderForType()
Returns
Type Description
SearchRequest.BoostSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchRequest.BoostSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchRequest.BoostSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SearchRequest.BoostSpec.Builder toBuilder()
Returns
Type Description
SearchRequest.BoostSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException