Send feedback
Class SearchResponse (0.16.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 0.16.0keyboard_arrow_down
public final class SearchResponse extends GeneratedMessageV3 implements SearchResponseOrBuilder
Response message for
SearchService.Search
method.
Protobuf type google.cloud.discoveryengine.v1.SearchResponse
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
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
NEXT_PAGE_TOKEN_FIELD_NUMBER
public static final int NEXT_PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int
RESULTS_FIELD_NUMBER
public static final int RESULTS_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 ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static SearchResponse . Builder newBuilder ()
newBuilder(SearchResponse prototype)
public static SearchResponse . Builder newBuilder ( SearchResponse prototype )
public static SearchResponse parseDelimitedFrom ( InputStream input )
public static SearchResponse parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static SearchResponse parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchResponse parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static SearchResponse parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchResponse parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static SearchResponse parseFrom ( CodedInputStream input )
public static SearchResponse parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static SearchResponse parseFrom ( InputStream input )
public static SearchResponse parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static SearchResponse parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchResponse parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<SearchResponse> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
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 ()
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 ()
Overrides
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
indexint
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;
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
indexint
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
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.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public SearchResponse . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchResponse . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public SearchResponse . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-30 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-30 UTC."],[],[]]
