Class SearchRequest.QueryExpansionSpec (0.25.0)

public static final class SearchRequest.QueryExpansionSpec extends GeneratedMessageV3 implements SearchRequest.QueryExpansionSpecOrBuilder

Specification to determine under which conditions query expansion should occur.

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

Inheritance

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

Static Fields

CONDITION_FIELD_NUMBER

public static final int CONDITION_FIELD_NUMBER
Field Value
TypeDescription
int

PIN_UNEXPANDED_RESULTS_FIELD_NUMBER

public static final int PIN_UNEXPANDED_RESULTS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SearchRequest.QueryExpansionSpec getDefaultInstance()
Returns
TypeDescription
SearchRequest.QueryExpansionSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static SearchRequest.QueryExpansionSpec.Builder newBuilder()
Returns
TypeDescription
SearchRequest.QueryExpansionSpec.Builder

newBuilder(SearchRequest.QueryExpansionSpec prototype)

public static SearchRequest.QueryExpansionSpec.Builder newBuilder(SearchRequest.QueryExpansionSpec prototype)
Parameter
NameDescription
prototypeSearchRequest.QueryExpansionSpec
Returns
TypeDescription
SearchRequest.QueryExpansionSpec.Builder

parseDelimitedFrom(InputStream input)

public static SearchRequest.QueryExpansionSpec parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchRequest.QueryExpansionSpec
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.QueryExpansionSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchRequest.QueryExpansionSpec
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SearchRequest.QueryExpansionSpec parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SearchRequest.QueryExpansionSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.QueryExpansionSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchRequest.QueryExpansionSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchRequest.QueryExpansionSpec parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SearchRequest.QueryExpansionSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.QueryExpansionSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchRequest.QueryExpansionSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchRequest.QueryExpansionSpec parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SearchRequest.QueryExpansionSpec
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.QueryExpansionSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchRequest.QueryExpansionSpec
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SearchRequest.QueryExpansionSpec parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchRequest.QueryExpansionSpec
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.QueryExpansionSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchRequest.QueryExpansionSpec
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SearchRequest.QueryExpansionSpec parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SearchRequest.QueryExpansionSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.QueryExpansionSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchRequest.QueryExpansionSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SearchRequest.QueryExpansionSpec> parser()
Returns
TypeDescription
Parser<QueryExpansionSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

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 condition = 1;

Returns
TypeDescription
SearchRequest.QueryExpansionSpec.Condition

The condition.

getConditionValue()

public int getConditionValue()

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

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

Returns
TypeDescription
int

The enum numeric value on the wire for condition.

getDefaultInstanceForType()

public SearchRequest.QueryExpansionSpec getDefaultInstanceForType()
Returns
TypeDescription
SearchRequest.QueryExpansionSpec

getParserForType()

public Parser<SearchRequest.QueryExpansionSpec> getParserForType()
Returns
TypeDescription
Parser<QueryExpansionSpec>
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
TypeDescription
boolean

The pinUnexpandedResults.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SearchRequest.QueryExpansionSpec.Builder newBuilderForType()
Returns
TypeDescription
SearchRequest.QueryExpansionSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchRequest.QueryExpansionSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SearchRequest.QueryExpansionSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SearchRequest.QueryExpansionSpec.Builder toBuilder()
Returns
TypeDescription
SearchRequest.QueryExpansionSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException