Class SearchResponse.QueryExpansionInfo (2.4.0)

public static final class SearchResponse.QueryExpansionInfo extends GeneratedMessageV3 implements SearchResponse.QueryExpansionInfoOrBuilder

Information describing query expansion including whether expansion has occurred.

Protobuf type google.cloud.retail.v2beta.SearchResponse.QueryExpansionInfo

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SearchResponse.QueryExpansionInfo

Static Fields

EXPANDED_QUERY_FIELD_NUMBER

public static final int EXPANDED_QUERY_FIELD_NUMBER
Field Value
TypeDescription
int

PINNED_RESULT_COUNT_FIELD_NUMBER

public static final int PINNED_RESULT_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SearchResponse.QueryExpansionInfo getDefaultInstance()
Returns
TypeDescription
SearchResponse.QueryExpansionInfo

getDescriptor()

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

newBuilder()

public static SearchResponse.QueryExpansionInfo.Builder newBuilder()
Returns
TypeDescription
SearchResponse.QueryExpansionInfo.Builder

newBuilder(SearchResponse.QueryExpansionInfo prototype)

public static SearchResponse.QueryExpansionInfo.Builder newBuilder(SearchResponse.QueryExpansionInfo prototype)
Parameter
NameDescription
prototypeSearchResponse.QueryExpansionInfo
Returns
TypeDescription
SearchResponse.QueryExpansionInfo.Builder

parseDelimitedFrom(InputStream input)

public static SearchResponse.QueryExpansionInfo parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchResponse.QueryExpansionInfo
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static SearchResponse.QueryExpansionInfo parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SearchResponse.QueryExpansionInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static SearchResponse.QueryExpansionInfo parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SearchResponse.QueryExpansionInfo
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static SearchResponse.QueryExpansionInfo parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchResponse.QueryExpansionInfo
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static SearchResponse.QueryExpansionInfo parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SearchResponse.QueryExpansionInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<SearchResponse.QueryExpansionInfo> parser()
Returns
TypeDescription
Parser<QueryExpansionInfo>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public SearchResponse.QueryExpansionInfo getDefaultInstanceForType()
Returns
TypeDescription
SearchResponse.QueryExpansionInfo

getExpandedQuery()

public boolean getExpandedQuery()

Bool describing whether query expansion has occurred.

bool expanded_query = 1;

Returns
TypeDescription
boolean

The expandedQuery.

getParserForType()

public Parser<SearchResponse.QueryExpansionInfo> getParserForType()
Returns
TypeDescription
Parser<QueryExpansionInfo>
Overrides

getPinnedResultCount()

public long getPinnedResultCount()

Number of pinned results. This field will only be set when expansion happens and SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true.

int64 pinned_result_count = 2;

Returns
TypeDescription
long

The pinnedResultCount.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
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 SearchResponse.QueryExpansionInfo.Builder newBuilderForType()
Returns
TypeDescription
SearchResponse.QueryExpansionInfo.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchResponse.QueryExpansionInfo.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SearchResponse.QueryExpansionInfo.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public SearchResponse.QueryExpansionInfo.Builder toBuilder()
Returns
TypeDescription
SearchResponse.QueryExpansionInfo.Builder

writeTo(CodedOutputStream output)

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