Class SearchRequest.BoostSpec.Builder (2.8.0)

public static final class SearchRequest.BoostSpec.Builder extends GeneratedMessageV3.Builder<SearchRequest.BoostSpec.Builder> implements SearchRequest.BoostSpecOrBuilder

Boost specification to boost certain items.

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

Inheritance

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

Implements

SearchRequest.BoostSpecOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

Methods

addAllConditionBoostSpecs(Iterable<? extends SearchRequest.BoostSpec.ConditionBoostSpec> values)

public SearchRequest.BoostSpec.Builder addAllConditionBoostSpecs(Iterable<? extends SearchRequest.BoostSpec.ConditionBoostSpec> values)

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
values	`Iterable<? extends com.google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec>`

Returns

Type	Description
SearchRequest.BoostSpec.Builder

addConditionBoostSpecs(SearchRequest.BoostSpec.ConditionBoostSpec value)

public SearchRequest.BoostSpec.Builder addConditionBoostSpecs(SearchRequest.BoostSpec.ConditionBoostSpec value)

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

Parameter

Name	Description
value	`SearchRequest.BoostSpec.ConditionBoostSpec`

Returns

Type	Description
SearchRequest.BoostSpec.Builder

addConditionBoostSpecs(SearchRequest.BoostSpec.ConditionBoostSpec.Builder builderForValue)

public SearchRequest.BoostSpec.Builder addConditionBoostSpecs(SearchRequest.BoostSpec.ConditionBoostSpec.Builder builderForValue)

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

Parameter

Name	Description
builderForValue	`SearchRequest.BoostSpec.ConditionBoostSpec.Builder`

Returns

Type	Description
SearchRequest.BoostSpec.Builder

addConditionBoostSpecs(int index, SearchRequest.BoostSpec.ConditionBoostSpec value)

public SearchRequest.BoostSpec.Builder addConditionBoostSpecs(int index, SearchRequest.BoostSpec.ConditionBoostSpec value)

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

Parameters

Name	Description
index	`int`
value	`SearchRequest.BoostSpec.ConditionBoostSpec`

Returns

Type	Description
SearchRequest.BoostSpec.Builder

addConditionBoostSpecs(int index, SearchRequest.BoostSpec.ConditionBoostSpec.Builder builderForValue)

public SearchRequest.BoostSpec.Builder addConditionBoostSpecs(int index, SearchRequest.BoostSpec.ConditionBoostSpec.Builder builderForValue)

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

Parameters

Name	Description
index	`int`
builderForValue	`SearchRequest.BoostSpec.ConditionBoostSpec.Builder`

Returns

Type	Description
SearchRequest.BoostSpec.Builder

addConditionBoostSpecsBuilder()

public SearchRequest.BoostSpec.ConditionBoostSpec.Builder addConditionBoostSpecsBuilder()

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

Returns

Type	Description
SearchRequest.BoostSpec.ConditionBoostSpec.Builder

addConditionBoostSpecsBuilder(int index)

public SearchRequest.BoostSpec.ConditionBoostSpec.Builder addConditionBoostSpecsBuilder(int index)

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

Parameter

Name	Description
index	`int`

Returns

Type	Description
SearchRequest.BoostSpec.ConditionBoostSpec.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchRequest.BoostSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
SearchRequest.BoostSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public SearchRequest.BoostSpec build()

Returns

Type	Description
SearchRequest.BoostSpec

buildPartial()

public SearchRequest.BoostSpec buildPartial()

Returns

Type	Description
SearchRequest.BoostSpec

clear()

public SearchRequest.BoostSpec.Builder clear()

Returns

Type	Description
SearchRequest.BoostSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearConditionBoostSpecs()

public SearchRequest.BoostSpec.Builder clearConditionBoostSpecs()

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

Returns

Type	Description
SearchRequest.BoostSpec.Builder

clearField(Descriptors.FieldDescriptor field)

public SearchRequest.BoostSpec.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	`FieldDescriptor`

Returns

Type	Description
SearchRequest.BoostSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchRequest.BoostSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	`OneofDescriptor`

Returns

Type	Description
SearchRequest.BoostSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearSkipBoostSpecValidation()

public SearchRequest.BoostSpec.Builder clearSkipBoostSpecValidation()

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
SearchRequest.BoostSpec.Builder	This builder for chaining.

clone()

public SearchRequest.BoostSpec.Builder clone()

Returns

Type	Description
SearchRequest.BoostSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getConditionBoostSpecs(int index)

public SearchRequest.BoostSpec.ConditionBoostSpec getConditionBoostSpecs(int index)

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

Parameter

Name	Description
index	`int`

Returns

Type	Description
SearchRequest.BoostSpec.ConditionBoostSpec

getConditionBoostSpecsBuilder(int index)

public SearchRequest.BoostSpec.ConditionBoostSpec.Builder getConditionBoostSpecsBuilder(int index)

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

Parameter

Name	Description
index	`int`

Returns

Type	Description
SearchRequest.BoostSpec.ConditionBoostSpec.Builder

getConditionBoostSpecsBuilderList()

public List<SearchRequest.BoostSpec.ConditionBoostSpec.Builder> getConditionBoostSpecsBuilderList()

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

Returns

Type	Description
List<Builder>

getConditionBoostSpecsCount()

public int getConditionBoostSpecsCount()

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

Returns

Type	Description
int

getConditionBoostSpecsList()

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

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)

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

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(SearchRequest.BoostSpec other)

public SearchRequest.BoostSpec.Builder mergeFrom(SearchRequest.BoostSpec other)

Parameter

Name	Description
other	`SearchRequest.BoostSpec`

Returns

Type	Description
SearchRequest.BoostSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchRequest.BoostSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	`CodedInputStream`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
SearchRequest.BoostSpec.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public SearchRequest.BoostSpec.Builder mergeFrom(Message other)

Parameter

Name	Description
other	`Message`

Returns

Type	Description
SearchRequest.BoostSpec.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.BoostSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
SearchRequest.BoostSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeConditionBoostSpecs(int index)

public SearchRequest.BoostSpec.Builder removeConditionBoostSpecs(int index)

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

Parameter

Name	Description
index	`int`

Returns

Type	Description
SearchRequest.BoostSpec.Builder

setConditionBoostSpecs(int index, SearchRequest.BoostSpec.ConditionBoostSpec value)

public SearchRequest.BoostSpec.Builder setConditionBoostSpecs(int index, SearchRequest.BoostSpec.ConditionBoostSpec value)

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

Parameters

Name	Description
index	`int`
value	`SearchRequest.BoostSpec.ConditionBoostSpec`

Returns

Type	Description
SearchRequest.BoostSpec.Builder

setConditionBoostSpecs(int index, SearchRequest.BoostSpec.ConditionBoostSpec.Builder builderForValue)

public SearchRequest.BoostSpec.Builder setConditionBoostSpecs(int index, SearchRequest.BoostSpec.ConditionBoostSpec.Builder builderForValue)

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

Parameters

Name	Description
index	`int`
builderForValue	`SearchRequest.BoostSpec.ConditionBoostSpec.Builder`

Returns

Type	Description
SearchRequest.BoostSpec.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public SearchRequest.BoostSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
SearchRequest.BoostSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

public SearchRequest.BoostSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
index	`int`
value	`Object`

Returns

Type	Description
SearchRequest.BoostSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSkipBoostSpecValidation(boolean value)

public SearchRequest.BoostSpec.Builder setSkipBoostSpecValidation(boolean value)

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;

Parameter

Name	Description
value	`boolean` The skipBoostSpecValidation to set.

Returns

Type	Description
SearchRequest.BoostSpec.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.BoostSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
SearchRequest.BoostSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)