Class SearchRequest.QueryExpansionSpec.Builder (2.44.0)

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

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

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

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

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchRequest.QueryExpansionSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
SearchRequest.QueryExpansionSpec.Builder
Overrides

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

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

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.QueryExpansionSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SearchRequest.QueryExpansionSpec.Builder
Overrides

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

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

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.QueryExpansionSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SearchRequest.QueryExpansionSpec.Builder
Overrides