Class SearchRequest.QueryExpansionSpec.Builder (2.2.3)

public static final class SearchRequest.QueryExpansionSpec.Builder extends GeneratedMessageV3.Builder<SearchRequest.QueryExpansionSpec.Builder> implements SearchRequest.QueryExpansionSpecOrBuilder

Specification to determine under which conditions query expansion should occur.

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

Inheritance

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

Implements

SearchRequest.QueryExpansionSpecOrBuilder

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)

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)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

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

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

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

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
SearchRequest.QueryExpansionSpec.Builder

Overrides

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

build()

public SearchRequest.QueryExpansionSpec build()

Returns

Type	Description
SearchRequest.QueryExpansionSpec

buildPartial()

public SearchRequest.QueryExpansionSpec buildPartial()

Returns

Type	Description
SearchRequest.QueryExpansionSpec

clear()

public SearchRequest.QueryExpansionSpec.Builder clear()

Returns

Type	Description
SearchRequest.QueryExpansionSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearCondition()

public SearchRequest.QueryExpansionSpec.Builder clearCondition()

The condition under which query expansion should occur. Default to Condition.DISABLED.

.google.cloud.retail.v2.SearchRequest.QueryExpansionSpec.Condition condition = 1;

Returns

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

clearField(Descriptors.FieldDescriptor field)

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

Parameter

Name	Description
field	`FieldDescriptor`

Returns

Type	Description
SearchRequest.QueryExpansionSpec.Builder

Overrides

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

Parameter

Name	Description
oneof	`OneofDescriptor`

Returns

Type	Description
SearchRequest.QueryExpansionSpec.Builder

Overrides

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

clearPinUnexpandedResults()

public SearchRequest.QueryExpansionSpec.Builder clearPinUnexpandedResults()

Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.

bool pin_unexpanded_results = 2;

Returns

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

clone()

public SearchRequest.QueryExpansionSpec.Builder clone()

Returns

Type	Description
SearchRequest.QueryExpansionSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getCondition()

public SearchRequest.QueryExpansionSpec.Condition getCondition()

The condition under which query expansion should occur. Default to Condition.DISABLED.

.google.cloud.retail.v2.SearchRequest.QueryExpansionSpec.Condition condition = 1;

Returns

Type	Description
SearchRequest.QueryExpansionSpec.Condition	The condition.

getConditionValue()

public int getConditionValue()

The condition under which query expansion should occur. Default to Condition.DISABLED.

.google.cloud.retail.v2.SearchRequest.QueryExpansionSpec.Condition condition = 1;

Returns

Type	Description
int	The enum numeric value on the wire for condition.

getDefaultInstanceForType()

public SearchRequest.QueryExpansionSpec getDefaultInstanceForType()

Returns

Type	Description
SearchRequest.QueryExpansionSpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getPinUnexpandedResults()

public boolean getPinUnexpandedResults()

Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.

bool pin_unexpanded_results = 2;

Returns

Type	Description
boolean	The pinUnexpandedResults.

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.QueryExpansionSpec other)

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

Parameter

Name	Description
other	`SearchRequest.QueryExpansionSpec`

Returns

Type	Description
SearchRequest.QueryExpansionSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters

Name	Description
input	`CodedInputStream`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
SearchRequest.QueryExpansionSpec.Builder

Overrides

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

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public SearchRequest.QueryExpansionSpec.Builder mergeFrom(Message other)

Parameter

Name	Description
other	`Message`

Returns

Type	Description
SearchRequest.QueryExpansionSpec.Builder

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
SearchRequest.QueryExpansionSpec.Builder

Overrides

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

setCondition(SearchRequest.QueryExpansionSpec.Condition value)

public SearchRequest.QueryExpansionSpec.Builder setCondition(SearchRequest.QueryExpansionSpec.Condition value)

The condition under which query expansion should occur. Default to Condition.DISABLED.

.google.cloud.retail.v2.SearchRequest.QueryExpansionSpec.Condition condition = 1;

Parameter

Name	Description
value	`SearchRequest.QueryExpansionSpec.Condition` The condition to set.

Returns

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

setConditionValue(int value)

public SearchRequest.QueryExpansionSpec.Builder setConditionValue(int value)

The condition under which query expansion should occur. Default to Condition.DISABLED.

.google.cloud.retail.v2.SearchRequest.QueryExpansionSpec.Condition condition = 1;

Parameter

Name	Description
value	`int` The enum numeric value on the wire for condition to set.

Returns

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

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
SearchRequest.QueryExpansionSpec.Builder

Overrides

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

setPinUnexpandedResults(boolean value)

public SearchRequest.QueryExpansionSpec.Builder setPinUnexpandedResults(boolean value)

Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.

bool pin_unexpanded_results = 2;

Parameter

Name	Description
value	`boolean` The pinUnexpandedResults to set.

Returns

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

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

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

Parameters

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

Returns

Type	Description
SearchRequest.QueryExpansionSpec.Builder

Overrides

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

setUnknownFields(UnknownFieldSet unknownFields)

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

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
SearchRequest.QueryExpansionSpec.Builder

Overrides

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