com.google.cloud.discoveryengine.v1

Class SearchRequest.QueryExpansionSpec.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessage.Builder<SearchRequest.QueryExpansionSpec.Builder>

com.google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec.Builder

All Implemented Interfaces:

SearchRequest.QueryExpansionSpecOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

SearchRequest.QueryExpansionSpec

public static final class SearchRequest.QueryExpansionSpec.Builder
extends com.google.protobuf.GeneratedMessage.Builder<SearchRequest.QueryExpansionSpec.Builder>
implements SearchRequest.QueryExpansionSpecOrBuilder

 Specification to determine under which conditions query expansion should
 occur.
 

Protobuf type google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec

Method Summary

Modifier and Type	Method and Description
SearchRequest.QueryExpansionSpec	build()
SearchRequest.QueryExpansionSpec	buildPartial()
SearchRequest.QueryExpansionSpec.Builder	clear()
SearchRequest.QueryExpansionSpec.Builder	clearCondition() The condition under which query expansion should occur.
SearchRequest.QueryExpansionSpec.Builder	clearPinUnexpandedResults() Whether to pin unexpanded results.
SearchRequest.QueryExpansionSpec.Condition	getCondition() The condition under which query expansion should occur.
int	getConditionValue() The condition under which query expansion should occur.
SearchRequest.QueryExpansionSpec	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
boolean	getPinUnexpandedResults() Whether to pin unexpanded results.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
SearchRequest.QueryExpansionSpec.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
SearchRequest.QueryExpansionSpec.Builder	mergeFrom(com.google.protobuf.Message other)
SearchRequest.QueryExpansionSpec.Builder	mergeFrom(SearchRequest.QueryExpansionSpec other)
SearchRequest.QueryExpansionSpec.Builder	setCondition(SearchRequest.QueryExpansionSpec.Condition value) The condition under which query expansion should occur.
SearchRequest.QueryExpansionSpec.Builder	setConditionValue(int value) The condition under which query expansion should occur.
SearchRequest.QueryExpansionSpec.Builder	setPinUnexpandedResults(boolean value) Whether to pin unexpanded results.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<SearchRequest.QueryExpansionSpec.Builder>

clear

public SearchRequest.QueryExpansionSpec.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<SearchRequest.QueryExpansionSpec.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<SearchRequest.QueryExpansionSpec.Builder>

getDefaultInstanceForType

public SearchRequest.QueryExpansionSpec getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public SearchRequest.QueryExpansionSpec build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public SearchRequest.QueryExpansionSpec buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public SearchRequest.QueryExpansionSpec.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchRequest.QueryExpansionSpec.Builder>

mergeFrom

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

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<SearchRequest.QueryExpansionSpec.Builder>

mergeFrom

public SearchRequest.QueryExpansionSpec.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchRequest.QueryExpansionSpec.Builder>

Throws:

IOException

getConditionValue

public int getConditionValue()

 The condition under which query expansion should occur. Default to
 [Condition.DISABLED][google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec.Condition.DISABLED].
 

.google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec.Condition condition = 1;

Specified by:

getConditionValue in interface SearchRequest.QueryExpansionSpecOrBuilder

Returns:

The enum numeric value on the wire for condition.

setConditionValue

public SearchRequest.QueryExpansionSpec.Builder setConditionValue(int value)

 The condition under which query expansion should occur. Default to
 [Condition.DISABLED][google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec.Condition.DISABLED].
 

.google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec.Condition condition = 1;

Parameters:

value - The enum numeric value on the wire for condition to set.

Returns:

This builder for chaining.

getCondition

public SearchRequest.QueryExpansionSpec.Condition getCondition()

 The condition under which query expansion should occur. Default to
 [Condition.DISABLED][google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec.Condition.DISABLED].
 

.google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec.Condition condition = 1;

Specified by:

getCondition in interface SearchRequest.QueryExpansionSpecOrBuilder

Returns:

The condition.

setCondition

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

 The condition under which query expansion should occur. Default to
 [Condition.DISABLED][google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec.Condition.DISABLED].
 

.google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec.Condition condition = 1;

Parameters:

value - The condition to set.

Returns:

This builder for chaining.

clearCondition

public SearchRequest.QueryExpansionSpec.Builder clearCondition()

 The condition under which query expansion should occur. Default to
 [Condition.DISABLED][google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec.Condition.DISABLED].
 

.google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec.Condition condition = 1;

Returns:

This builder for chaining.

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;

Specified by:

getPinUnexpandedResults in interface SearchRequest.QueryExpansionSpecOrBuilder

Returns:

The pinUnexpandedResults.

setPinUnexpandedResults

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;

Parameters:

value - The pinUnexpandedResults to set.

Returns:

This builder for chaining.

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:

This builder for chaining.