public final class SearchResponse extends GeneratedMessageV3 implements SearchResponseOrBuilder
Response message for
SearchService.Search
method.
Protobuf type google.cloud.discoveryengine.v1beta.SearchResponse
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
APPLIED_CONTROLS_FIELD_NUMBER
public static final int APPLIED_CONTROLS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
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 |
|
GEO_SEARCH_DEBUG_INFO_FIELD_NUMBER
public static final int GEO_SEARCH_DEBUG_INFO_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
GUIDED_SEARCH_RESULT_FIELD_NUMBER
public static final int GUIDED_SEARCH_RESULT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NATURAL_LANGUAGE_QUERY_UNDERSTANDING_INFO_FIELD_NUMBER
public static final int NATURAL_LANGUAGE_QUERY_UNDERSTANDING_INFO_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 |
|
ONE_BOX_RESULTS_FIELD_NUMBER
public static final int ONE_BOX_RESULTS_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 |
|
SESSION_INFO_FIELD_NUMBER
public static final int SESSION_INFO_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()
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 |
data |
byte[]
|
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 |
obj |
Object
|
Overrides
getAppliedControls(int index)
public String getAppliedControls(int index)
Controls applied as part of the Control service.
repeated string applied_controls = 10;
| Parameter |
| Name |
Description |
index |
int
The index of the element to return.
|
| Returns |
| Type |
Description |
String |
The appliedControls at the given index.
|
getAppliedControlsBytes(int index)
public ByteString getAppliedControlsBytes(int index)
Controls applied as part of the Control service.
repeated string applied_controls = 10;
| Parameter |
| Name |
Description |
index |
int
The index of the value to return.
|
| Returns |
| Type |
Description |
ByteString |
The bytes of the appliedControls at the given index.
|
getAppliedControlsCount()
public int getAppliedControlsCount()
Controls applied as part of the Control service.
repeated string applied_controls = 10;
| Returns |
| Type |
Description |
int |
The count of appliedControls.
|
getAppliedControlsList()
public ProtocolStringList getAppliedControlsList()
Controls applied as part of the Control service.
repeated string applied_controls = 10;
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. This also helps to identify a request during the customer
support scenarios.
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. This also helps to identify a request during the customer
support scenarios.
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()
getFacets(int index)
public SearchResponse.Facet getFacets(int index)
Results of facets requested by user.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Facet facets = 2;
| Parameter |
| Name |
Description |
index |
int
|
getFacetsCount()
public int getFacetsCount()
Results of facets requested by user.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Facet facets = 2;
| Returns |
| Type |
Description |
int |
|
getFacetsList()
public List<SearchResponse.Facet> getFacetsList()
Results of facets requested by user.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Facet facets = 2;
getFacetsOrBuilder(int index)
public SearchResponse.FacetOrBuilder getFacetsOrBuilder(int index)
Results of facets requested by user.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Facet facets = 2;
| Parameter |
| Name |
Description |
index |
int
|
getFacetsOrBuilderList()
public List<? extends SearchResponse.FacetOrBuilder> getFacetsOrBuilderList()
Results of facets requested by user.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Facet facets = 2;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.discoveryengine.v1beta.SearchResponse.FacetOrBuilder> |
|
getGeoSearchDebugInfo(int index)
public SearchResponse.GeoSearchDebugInfo getGeoSearchDebugInfo(int index)
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.GeoSearchDebugInfo geo_search_debug_info = 16;
| Parameter |
| Name |
Description |
index |
int
|
getGeoSearchDebugInfoCount()
public int getGeoSearchDebugInfoCount()
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.GeoSearchDebugInfo geo_search_debug_info = 16;
| Returns |
| Type |
Description |
int |
|
getGeoSearchDebugInfoList()
public List<SearchResponse.GeoSearchDebugInfo> getGeoSearchDebugInfoList()
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.GeoSearchDebugInfo geo_search_debug_info = 16;
getGeoSearchDebugInfoOrBuilder(int index)
public SearchResponse.GeoSearchDebugInfoOrBuilder getGeoSearchDebugInfoOrBuilder(int index)
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.GeoSearchDebugInfo geo_search_debug_info = 16;
| Parameter |
| Name |
Description |
index |
int
|
getGeoSearchDebugInfoOrBuilderList()
public List<? extends SearchResponse.GeoSearchDebugInfoOrBuilder> getGeoSearchDebugInfoOrBuilderList()
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.GeoSearchDebugInfo geo_search_debug_info = 16;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.discoveryengine.v1beta.SearchResponse.GeoSearchDebugInfoOrBuilder> |
|
getGuidedSearchResult()
public SearchResponse.GuidedSearchResult getGuidedSearchResult()
Guided search result.
.google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult guided_search_result = 8;
getGuidedSearchResultOrBuilder()
public SearchResponse.GuidedSearchResultOrBuilder getGuidedSearchResultOrBuilder()
Guided search result.
.google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult guided_search_result = 8;
getNaturalLanguageQueryUnderstandingInfo()
public SearchResponse.NaturalLanguageQueryUnderstandingInfo getNaturalLanguageQueryUnderstandingInfo()
Natural language query understanding information for the returned results.
.google.cloud.discoveryengine.v1beta.SearchResponse.NaturalLanguageQueryUnderstandingInfo natural_language_query_understanding_info = 15;
getNaturalLanguageQueryUnderstandingInfoOrBuilder()
public SearchResponse.NaturalLanguageQueryUnderstandingInfoOrBuilder getNaturalLanguageQueryUnderstandingInfoOrBuilder()
Natural language query understanding information for the returned results.
.google.cloud.discoveryengine.v1beta.SearchResponse.NaturalLanguageQueryUnderstandingInfo natural_language_query_understanding_info = 15;
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.
|
getOneBoxResults(int index)
public SearchResponse.OneBoxResult getOneBoxResults(int index)
A list of One Box results. There can be multiple One Box results of
different types.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.OneBoxResult one_box_results = 20;
| Parameter |
| Name |
Description |
index |
int
|
getOneBoxResultsCount()
public int getOneBoxResultsCount()
A list of One Box results. There can be multiple One Box results of
different types.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.OneBoxResult one_box_results = 20;
| Returns |
| Type |
Description |
int |
|
getOneBoxResultsList()
public List<SearchResponse.OneBoxResult> getOneBoxResultsList()
A list of One Box results. There can be multiple One Box results of
different types.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.OneBoxResult one_box_results = 20;
getOneBoxResultsOrBuilder(int index)
public SearchResponse.OneBoxResultOrBuilder getOneBoxResultsOrBuilder(int index)
A list of One Box results. There can be multiple One Box results of
different types.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.OneBoxResult one_box_results = 20;
| Parameter |
| Name |
Description |
index |
int
|
getOneBoxResultsOrBuilderList()
public List<? extends SearchResponse.OneBoxResultOrBuilder> getOneBoxResultsOrBuilderList()
A list of One Box results. There can be multiple One Box results of
different types.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.OneBoxResult one_box_results = 20;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.discoveryengine.v1beta.SearchResponse.OneBoxResultOrBuilder> |
|
getParserForType()
public Parser<SearchResponse> getParserForType()
Overrides
getQueryExpansionInfo()
public SearchResponse.QueryExpansionInfo getQueryExpansionInfo()
Query expansion information for the returned results.
.google.cloud.discoveryengine.v1beta.SearchResponse.QueryExpansionInfo query_expansion_info = 14;
getQueryExpansionInfoOrBuilder()
public SearchResponse.QueryExpansionInfoOrBuilder getQueryExpansionInfoOrBuilder()
Query expansion information for the returned results.
.google.cloud.discoveryengine.v1beta.SearchResponse.QueryExpansionInfo query_expansion_info = 14;
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.v1beta.SearchResponse.SearchResult results = 1;
| Parameter |
| Name |
Description |
index |
int
|
getResultsCount()
public int getResultsCount()
A list of matched documents. The order represents the ranking.
repeated .google.cloud.discoveryengine.v1beta.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.v1beta.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.v1beta.SearchResponse.SearchResult results = 1;
| Parameter |
| Name |
Description |
index |
int
|
getResultsOrBuilderList()
public List<? extends SearchResponse.SearchResultOrBuilder> getResultsOrBuilderList()
A list of matched documents. The order represents the ranking.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult results = 1;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.discoveryengine.v1beta.SearchResponse.SearchResultOrBuilder> |
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getSessionInfo()
public SearchResponse.SessionInfo getSessionInfo()
Session information.
Only set if
SearchRequest.session
is provided. See its description for more details.
.google.cloud.discoveryengine.v1beta.SearchResponse.SessionInfo session_info = 19;
getSessionInfoOrBuilder()
public SearchResponse.SessionInfoOrBuilder getSessionInfoOrBuilder()
Session information.
Only set if
SearchRequest.session
is provided. See its description for more details.
.google.cloud.discoveryengine.v1beta.SearchResponse.SessionInfo session_info = 19;
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.v1beta.SearchResponse.Summary summary = 9;
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.v1beta.SearchResponse.Summary summary = 9;
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.
|
hasGuidedSearchResult()
public boolean hasGuidedSearchResult()
Guided search result.
.google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult guided_search_result = 8;
| Returns |
| Type |
Description |
boolean |
Whether the guidedSearchResult field is set.
|
hasNaturalLanguageQueryUnderstandingInfo()
public boolean hasNaturalLanguageQueryUnderstandingInfo()
Natural language query understanding information for the returned results.
.google.cloud.discoveryengine.v1beta.SearchResponse.NaturalLanguageQueryUnderstandingInfo natural_language_query_understanding_info = 15;
| Returns |
| Type |
Description |
boolean |
Whether the naturalLanguageQueryUnderstandingInfo field is set.
|
hasQueryExpansionInfo()
public boolean hasQueryExpansionInfo()
Query expansion information for the returned results.
.google.cloud.discoveryengine.v1beta.SearchResponse.QueryExpansionInfo query_expansion_info = 14;
| Returns |
| Type |
Description |
boolean |
Whether the queryExpansionInfo field is set.
|
hasSessionInfo()
public boolean hasSessionInfo()
Session information.
Only set if
SearchRequest.session
is provided. See its description for more details.
.google.cloud.discoveryengine.v1beta.SearchResponse.SessionInfo session_info = 19;
| Returns |
| Type |
Description |
boolean |
Whether the sessionInfo 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.v1beta.SearchResponse.Summary summary = 9;
| Returns |
| Type |
Description |
boolean |
Whether the summary field is set.
|
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
