Class SearchResponse (0.31.0)

Version 0.31.0

• 0.49.0 (latest)
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public final class SearchResponse extends GeneratedMessageV3 implements SearchResponseOrBuilder

Response message for SearchService.Search method.

Protobuf type google.cloud.discoveryengine.v1.SearchResponse

Inheritance

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

Implements

SearchResponseOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ATTRIBUTION_TOKEN_FIELD_NUMBER

public static final int ATTRIBUTION_TOKEN_FIELD_NUMBER

Field Value
Type	Description
int

CORRECTED_QUERY_FIELD_NUMBER

public static final int CORRECTED_QUERY_FIELD_NUMBER

Field Value
Type	Description
int

FACETS_FIELD_NUMBER

public static final int FACETS_FIELD_NUMBER

Field Value
Type	Description
int

NEXT_PAGE_TOKEN_FIELD_NUMBER

public static final int NEXT_PAGE_TOKEN_FIELD_NUMBER

Field Value
Type	Description
int

QUERY_EXPANSION_INFO_FIELD_NUMBER

public static final int QUERY_EXPANSION_INFO_FIELD_NUMBER

Field Value
Type	Description
int

REDIRECT_URI_FIELD_NUMBER

public static final int REDIRECT_URI_FIELD_NUMBER

Field Value
Type	Description
int

RESULTS_FIELD_NUMBER

public static final int RESULTS_FIELD_NUMBER

Field Value
Type	Description
int

SUMMARY_FIELD_NUMBER

public static final int SUMMARY_FIELD_NUMBER

Field Value
Type	Description
int

TOTAL_SIZE_FIELD_NUMBER

public static final int TOTAL_SIZE_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static SearchResponse getDefaultInstance()

Returns
Type	Description
SearchResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static SearchResponse.Builder newBuilder()

Returns
Type	Description
SearchResponse.Builder

newBuilder(SearchResponse prototype)

public static SearchResponse.Builder newBuilder(SearchResponse prototype)

Parameter
Name	Description
prototype	SearchResponse

Returns
Type	Description
SearchResponse.Builder

parseDelimitedFrom(InputStream input)

public static SearchResponse parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
SearchResponse

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchResponse

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static SearchResponse parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
SearchResponse

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchResponse

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchResponse parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
SearchResponse

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchResponse

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchResponse parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
SearchResponse

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchResponse

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static SearchResponse parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
SearchResponse

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchResponse

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static SearchResponse parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
SearchResponse

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchResponse

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<SearchResponse> parser()

Returns
Type	Description
Parser<SearchResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getAttributionToken()

public String getAttributionToken()

A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance.

string attribution_token = 4;

Returns
Type	Description
String	The attributionToken.

getAttributionTokenBytes()

public ByteString getAttributionTokenBytes()

A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance.

string attribution_token = 4;

Returns
Type	Description
ByteString	The bytes for attributionToken.

getCorrectedQuery()

public String getCorrectedQuery()

Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search.

string corrected_query = 7;

Returns
Type	Description
String	The correctedQuery.

getCorrectedQueryBytes()

public ByteString getCorrectedQueryBytes()

Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search.

string corrected_query = 7;

Returns
Type	Description
ByteString	The bytes for correctedQuery.

getDefaultInstanceForType()

public SearchResponse getDefaultInstanceForType()

Returns
Type	Description
SearchResponse

getFacets(int index)

public SearchResponse.Facet getFacets(int index)

Results of facets requested by user.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Facet facets = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
SearchResponse.Facet

getFacetsCount()

public int getFacetsCount()

Results of facets requested by user.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Facet facets = 2;

Returns
Type	Description
int

getFacetsList()

public List<SearchResponse.Facet> getFacetsList()

Results of facets requested by user.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Facet facets = 2;

Returns
Type	Description
List<Facet>

getFacetsOrBuilder(int index)

public SearchResponse.FacetOrBuilder getFacetsOrBuilder(int index)

Results of facets requested by user.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Facet facets = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
SearchResponse.FacetOrBuilder

getFacetsOrBuilderList()

public List<? extends SearchResponse.FacetOrBuilder> getFacetsOrBuilderList()

Results of facets requested by user.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Facet facets = 2;

Returns
Type	Description
List<? extends com.google.cloud.discoveryengine.v1.SearchResponse.FacetOrBuilder>

getNextPageToken()

public String getNextPageToken()

A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

string next_page_token = 5;

Returns
Type	Description
String	The nextPageToken.

getNextPageTokenBytes()

public ByteString getNextPageTokenBytes()

A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

string next_page_token = 5;

Returns
Type	Description
ByteString	The bytes for nextPageToken.

getParserForType()

public Parser<SearchResponse> getParserForType()

Returns
Type	Description
Parser<SearchResponse>

Overrides

GeneratedMessageV3.getParserForType()

getQueryExpansionInfo()

public SearchResponse.QueryExpansionInfo getQueryExpansionInfo()

Query expansion information for the returned results.

.google.cloud.discoveryengine.v1.SearchResponse.QueryExpansionInfo query_expansion_info = 14;

Returns
Type	Description
SearchResponse.QueryExpansionInfo	The queryExpansionInfo.

getQueryExpansionInfoOrBuilder()

public SearchResponse.QueryExpansionInfoOrBuilder getQueryExpansionInfoOrBuilder()

Query expansion information for the returned results.

.google.cloud.discoveryengine.v1.SearchResponse.QueryExpansionInfo query_expansion_info = 14;

Returns
Type	Description
SearchResponse.QueryExpansionInfoOrBuilder

getRedirectUri()

public String getRedirectUri()

The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only redirect_uri and attribution_token are set in the response.

string redirect_uri = 12;

Returns
Type	Description
String	The redirectUri.

getRedirectUriBytes()

public ByteString getRedirectUriBytes()

The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only redirect_uri and attribution_token are set in the response.

string redirect_uri = 12;

Returns
Type	Description
ByteString	The bytes for redirectUri.

getResults(int index)

public SearchResponse.SearchResult getResults(int index)

A list of matched documents. The order represents the ranking.

repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
SearchResponse.SearchResult

getResultsCount()

public int getResultsCount()

A list of matched documents. The order represents the ranking.

repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;

Returns
Type	Description
int

getResultsList()

public List<SearchResponse.SearchResult> getResultsList()

A list of matched documents. The order represents the ranking.

repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;

Returns
Type	Description
List<SearchResult>

getResultsOrBuilder(int index)

public SearchResponse.SearchResultOrBuilder getResultsOrBuilder(int index)

A list of matched documents. The order represents the ranking.

repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
SearchResponse.SearchResultOrBuilder

getResultsOrBuilderList()

public List<? extends SearchResponse.SearchResultOrBuilder> getResultsOrBuilderList()

A list of matched documents. The order represents the ranking.

repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult results = 1;

Returns
Type	Description
List<? extends com.google.cloud.discoveryengine.v1.SearchResponse.SearchResultOrBuilder>

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getSummary()

public SearchResponse.Summary getSummary()

A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.

.google.cloud.discoveryengine.v1.SearchResponse.Summary summary = 9;

Returns
Type	Description
SearchResponse.Summary	The summary.

getSummaryOrBuilder()

public SearchResponse.SummaryOrBuilder getSummaryOrBuilder()

A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.

.google.cloud.discoveryengine.v1.SearchResponse.Summary summary = 9;

Returns
Type	Description
SearchResponse.SummaryOrBuilder

getTotalSize()

public int getTotalSize()

The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches.

int32 total_size = 3;

Returns
Type	Description
int	The totalSize.

hasQueryExpansionInfo()

public boolean hasQueryExpansionInfo()

Query expansion information for the returned results.

.google.cloud.discoveryengine.v1.SearchResponse.QueryExpansionInfo query_expansion_info = 14;

Returns
Type	Description
boolean	Whether the queryExpansionInfo field is set.

hasSummary()

public boolean hasSummary()

A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.

.google.cloud.discoveryengine.v1.SearchResponse.Summary summary = 9;

Returns
Type	Description
boolean	Whether the summary field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public SearchResponse.Builder newBuilderForType()

Returns
Type	Description
SearchResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
SearchResponse.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public SearchResponse.Builder toBuilder()

Returns
Type	Description
SearchResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException