Class SearchResponse
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.discoveryengine.v1beta.SearchResponse
- All Implemented Interfaces:
SearchResponseOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
@Generated
public final class SearchResponse
extends com.google.protobuf.GeneratedMessage
implements SearchResponseOrBuilder
Response message for [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] method.Protobuf type
google.cloud.discoveryengine.v1beta.SearchResponse- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classResponse message for [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] method.static final classA facet result.static interfacestatic final classDebug information specifically related to forward geocoding issues arising from Geolocation Search.static interfacestatic final classGuided search result.static interfacestatic final classInformation describing what natural language understanding was done on the input query.static interfacestatic final classOneBoxResult is a holder for all results of specific type that we want to display in UI differently.static interfacestatic final classInformation describing query expansion including whether expansion has occurred.static interfacestatic final classRepresents the search results.static interfacestatic final classInformation about the session.static interfacestatic final classSummary of the top N search results specified by the summary spec.static interfaceNested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleangetAppliedControls(int index) Controls applied as part of the Control service.com.google.protobuf.ByteStringgetAppliedControlsBytes(int index) Controls applied as part of the Control service.intControls applied as part of the Control service.com.google.protobuf.ProtocolStringListControls applied as part of the Control service.A unique search token.com.google.protobuf.ByteStringA unique search token.Contains the spell corrected query, if found.com.google.protobuf.ByteStringContains the spell corrected query, if found.static SearchResponsestatic final com.google.protobuf.Descriptors.DescriptorgetFacets(int index) Results of facets requested by user.intResults of facets requested by user.Results of facets requested by user.getFacetsOrBuilder(int index) Results of facets requested by user.List<? extends SearchResponse.FacetOrBuilder>Results of facets requested by user.getGeoSearchDebugInfo(int index) repeated .google.cloud.discoveryengine.v1beta.SearchResponse.GeoSearchDebugInfo geo_search_debug_info = 16;intrepeated .google.cloud.discoveryengine.v1beta.SearchResponse.GeoSearchDebugInfo geo_search_debug_info = 16;repeated .google.cloud.discoveryengine.v1beta.SearchResponse.GeoSearchDebugInfo geo_search_debug_info = 16;getGeoSearchDebugInfoOrBuilder(int index) repeated .google.cloud.discoveryengine.v1beta.SearchResponse.GeoSearchDebugInfo geo_search_debug_info = 16;List<? extends SearchResponse.GeoSearchDebugInfoOrBuilder>repeated .google.cloud.discoveryengine.v1beta.SearchResponse.GeoSearchDebugInfo geo_search_debug_info = 16;Guided search result.Guided search result.Natural language query understanding information for the returned results.Natural language query understanding information for the returned results.A token that can be sent as [SearchRequest.page_token][google.cloud.discoveryengine.v1beta.SearchRequest.page_token] to retrieve the next page.com.google.protobuf.ByteStringA token that can be sent as [SearchRequest.page_token][google.cloud.discoveryengine.v1beta.SearchRequest.page_token] to retrieve the next page.getOneBoxResults(int index) A list of One Box results.intA list of One Box results.A list of One Box results.getOneBoxResultsOrBuilder(int index) A list of One Box results.List<? extends SearchResponse.OneBoxResultOrBuilder>A list of One Box results.com.google.protobuf.Parser<SearchResponse>Query expansion information for the returned results.Query expansion information for the returned results.The URI of a customer-defined redirect page.com.google.protobuf.ByteStringThe URI of a customer-defined redirect page.getResults(int index) A list of matched documents.intA list of matched documents.A list of matched documents.getResultsOrBuilder(int index) A list of matched documents.List<? extends SearchResponse.SearchResultOrBuilder>A list of matched documents.intSession information.Session information.A summary as part of the search results.A summary as part of the search results.intThe estimated total count of matched items irrespective of pagination.booleanGuided search result.inthashCode()booleanNatural language query understanding information for the returned results.booleanQuery expansion information for the returned results.booleanSession information.booleanA summary as part of the search results.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanstatic SearchResponse.Builderstatic SearchResponse.BuildernewBuilder(SearchResponse prototype) protected SearchResponse.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static SearchResponseparseDelimitedFrom(InputStream input) static SearchResponseparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static SearchResponseparseFrom(byte[] data) static SearchResponseparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static SearchResponseparseFrom(com.google.protobuf.ByteString data) static SearchResponseparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static SearchResponseparseFrom(com.google.protobuf.CodedInputStream input) static SearchResponseparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static SearchResponseparseFrom(InputStream input) static SearchResponseparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static SearchResponseparseFrom(ByteBuffer data) static SearchResponseparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<SearchResponse>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
RESULTS_FIELD_NUMBER
public static final int RESULTS_FIELD_NUMBER- See Also:
-
FACETS_FIELD_NUMBER
public static final int FACETS_FIELD_NUMBER- See Also:
-
GUIDED_SEARCH_RESULT_FIELD_NUMBER
public static final int GUIDED_SEARCH_RESULT_FIELD_NUMBER- See Also:
-
TOTAL_SIZE_FIELD_NUMBER
public static final int TOTAL_SIZE_FIELD_NUMBER- See Also:
-
ATTRIBUTION_TOKEN_FIELD_NUMBER
public static final int ATTRIBUTION_TOKEN_FIELD_NUMBER- See Also:
-
REDIRECT_URI_FIELD_NUMBER
public static final int REDIRECT_URI_FIELD_NUMBER- See Also:
-
NEXT_PAGE_TOKEN_FIELD_NUMBER
public static final int NEXT_PAGE_TOKEN_FIELD_NUMBER- See Also:
-
CORRECTED_QUERY_FIELD_NUMBER
public static final int CORRECTED_QUERY_FIELD_NUMBER- See Also:
-
SUMMARY_FIELD_NUMBER
public static final int SUMMARY_FIELD_NUMBER- See Also:
-
APPLIED_CONTROLS_FIELD_NUMBER
public static final int APPLIED_CONTROLS_FIELD_NUMBER- See Also:
-
GEO_SEARCH_DEBUG_INFO_FIELD_NUMBER
public static final int GEO_SEARCH_DEBUG_INFO_FIELD_NUMBER- See Also:
-
QUERY_EXPANSION_INFO_FIELD_NUMBER
public static final int QUERY_EXPANSION_INFO_FIELD_NUMBER- See Also:
-
NATURAL_LANGUAGE_QUERY_UNDERSTANDING_INFO_FIELD_NUMBER
public static final int NATURAL_LANGUAGE_QUERY_UNDERSTANDING_INFO_FIELD_NUMBER- See Also:
-
SESSION_INFO_FIELD_NUMBER
public static final int SESSION_INFO_FIELD_NUMBER- See Also:
-
ONE_BOX_RESULTS_FIELD_NUMBER
public static final int ONE_BOX_RESULTS_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
getResultsList
A list of matched documents. The order represents the ranking.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult results = 1;- Specified by:
getResultsListin interfaceSearchResponseOrBuilder
-
getResultsOrBuilderList
A list of matched documents. The order represents the ranking.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult results = 1;- Specified by:
getResultsOrBuilderListin interfaceSearchResponseOrBuilder
-
getResultsCount
public int getResultsCount()A list of matched documents. The order represents the ranking.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult results = 1;- Specified by:
getResultsCountin interfaceSearchResponseOrBuilder
-
getResults
A list of matched documents. The order represents the ranking.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult results = 1;- Specified by:
getResultsin interfaceSearchResponseOrBuilder
-
getResultsOrBuilder
A list of matched documents. The order represents the ranking.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult results = 1;- Specified by:
getResultsOrBuilderin interfaceSearchResponseOrBuilder
-
getFacetsList
Results of facets requested by user.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Facet facets = 2;- Specified by:
getFacetsListin interfaceSearchResponseOrBuilder
-
getFacetsOrBuilderList
Results of facets requested by user.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Facet facets = 2;- Specified by:
getFacetsOrBuilderListin interfaceSearchResponseOrBuilder
-
getFacetsCount
public int getFacetsCount()Results of facets requested by user.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Facet facets = 2;- Specified by:
getFacetsCountin interfaceSearchResponseOrBuilder
-
getFacets
Results of facets requested by user.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Facet facets = 2;- Specified by:
getFacetsin interfaceSearchResponseOrBuilder
-
getFacetsOrBuilder
Results of facets requested by user.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Facet facets = 2;- Specified by:
getFacetsOrBuilderin interfaceSearchResponseOrBuilder
-
hasGuidedSearchResult
public boolean hasGuidedSearchResult()Guided search result.
.google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult guided_search_result = 8;- Specified by:
hasGuidedSearchResultin interfaceSearchResponseOrBuilder- Returns:
- Whether the guidedSearchResult field is set.
-
getGuidedSearchResult
Guided search result.
.google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult guided_search_result = 8;- Specified by:
getGuidedSearchResultin interfaceSearchResponseOrBuilder- Returns:
- The guidedSearchResult.
-
getGuidedSearchResultOrBuilder
Guided search result.
.google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult guided_search_result = 8;- Specified by:
getGuidedSearchResultOrBuilderin interfaceSearchResponseOrBuilder
-
getTotalSize
public int getTotalSize()The estimated total count of matched items irrespective of pagination. The count of [results][google.cloud.discoveryengine.v1beta.SearchResponse.results] returned by pagination may be less than the [total_size][google.cloud.discoveryengine.v1beta.SearchResponse.total_size] that matches.
int32 total_size = 3;- Specified by:
getTotalSizein interfaceSearchResponseOrBuilder- Returns:
- The totalSize.
-
getAttributionToken
A unique search token. This should be included in the [UserEvent][google.cloud.discoveryengine.v1beta.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;- Specified by:
getAttributionTokenin interfaceSearchResponseOrBuilder- Returns:
- The attributionToken.
-
getAttributionTokenBytes
public com.google.protobuf.ByteString getAttributionTokenBytes()A unique search token. This should be included in the [UserEvent][google.cloud.discoveryengine.v1beta.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;- Specified by:
getAttributionTokenBytesin interfaceSearchResponseOrBuilder- Returns:
- The bytes for attributionToken.
-
getRedirectUri
The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only [redirect_uri][google.cloud.discoveryengine.v1beta.SearchResponse.redirect_uri] and [attribution_token][google.cloud.discoveryengine.v1beta.SearchResponse.attribution_token] are set in the response.
string redirect_uri = 12;- Specified by:
getRedirectUriin interfaceSearchResponseOrBuilder- Returns:
- The redirectUri.
-
getRedirectUriBytes
public com.google.protobuf.ByteString getRedirectUriBytes()The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only [redirect_uri][google.cloud.discoveryengine.v1beta.SearchResponse.redirect_uri] and [attribution_token][google.cloud.discoveryengine.v1beta.SearchResponse.attribution_token] are set in the response.
string redirect_uri = 12;- Specified by:
getRedirectUriBytesin interfaceSearchResponseOrBuilder- Returns:
- The bytes for redirectUri.
-
getNextPageToken
A token that can be sent as [SearchRequest.page_token][google.cloud.discoveryengine.v1beta.SearchRequest.page_token] to retrieve the next page. If this field is omitted, there are no subsequent pages.
string next_page_token = 5;- Specified by:
getNextPageTokenin interfaceSearchResponseOrBuilder- Returns:
- The nextPageToken.
-
getNextPageTokenBytes
public com.google.protobuf.ByteString getNextPageTokenBytes()A token that can be sent as [SearchRequest.page_token][google.cloud.discoveryengine.v1beta.SearchRequest.page_token] to retrieve the next page. If this field is omitted, there are no subsequent pages.
string next_page_token = 5;- Specified by:
getNextPageTokenBytesin interfaceSearchResponseOrBuilder- Returns:
- The bytes for nextPageToken.
-
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;- Specified by:
getCorrectedQueryin interfaceSearchResponseOrBuilder- Returns:
- The correctedQuery.
-
getCorrectedQueryBytes
public com.google.protobuf.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;- Specified by:
getCorrectedQueryBytesin interfaceSearchResponseOrBuilder- Returns:
- The bytes for correctedQuery.
-
hasSummary
public boolean hasSummary()A summary as part of the search results. This field is only returned if [SearchRequest.ContentSearchSpec.summary_spec][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.summary_spec] is set.
.google.cloud.discoveryengine.v1beta.SearchResponse.Summary summary = 9;- Specified by:
hasSummaryin interfaceSearchResponseOrBuilder- Returns:
- Whether the summary field is set.
-
getSummary
A summary as part of the search results. This field is only returned if [SearchRequest.ContentSearchSpec.summary_spec][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.summary_spec] is set.
.google.cloud.discoveryengine.v1beta.SearchResponse.Summary summary = 9;- Specified by:
getSummaryin interfaceSearchResponseOrBuilder- Returns:
- The summary.
-
getSummaryOrBuilder
A summary as part of the search results. This field is only returned if [SearchRequest.ContentSearchSpec.summary_spec][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.summary_spec] is set.
.google.cloud.discoveryengine.v1beta.SearchResponse.Summary summary = 9;- Specified by:
getSummaryOrBuilderin interfaceSearchResponseOrBuilder
-
getAppliedControlsList
public com.google.protobuf.ProtocolStringList getAppliedControlsList()Controls applied as part of the Control service.
repeated string applied_controls = 10;- Specified by:
getAppliedControlsListin interfaceSearchResponseOrBuilder- Returns:
- A list containing the appliedControls.
-
getAppliedControlsCount
public int getAppliedControlsCount()Controls applied as part of the Control service.
repeated string applied_controls = 10;- Specified by:
getAppliedControlsCountin interfaceSearchResponseOrBuilder- Returns:
- The count of appliedControls.
-
getAppliedControls
Controls applied as part of the Control service.
repeated string applied_controls = 10;- Specified by:
getAppliedControlsin interfaceSearchResponseOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The appliedControls at the given index.
-
getAppliedControlsBytes
public com.google.protobuf.ByteString getAppliedControlsBytes(int index) Controls applied as part of the Control service.
repeated string applied_controls = 10;- Specified by:
getAppliedControlsBytesin interfaceSearchResponseOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the appliedControls at the given index.
-
getGeoSearchDebugInfoList
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.GeoSearchDebugInfo geo_search_debug_info = 16;- Specified by:
getGeoSearchDebugInfoListin interfaceSearchResponseOrBuilder
-
getGeoSearchDebugInfoOrBuilderList
public List<? extends SearchResponse.GeoSearchDebugInfoOrBuilder> getGeoSearchDebugInfoOrBuilderList()repeated .google.cloud.discoveryengine.v1beta.SearchResponse.GeoSearchDebugInfo geo_search_debug_info = 16;- Specified by:
getGeoSearchDebugInfoOrBuilderListin interfaceSearchResponseOrBuilder
-
getGeoSearchDebugInfoCount
public int getGeoSearchDebugInfoCount()repeated .google.cloud.discoveryengine.v1beta.SearchResponse.GeoSearchDebugInfo geo_search_debug_info = 16;- Specified by:
getGeoSearchDebugInfoCountin interfaceSearchResponseOrBuilder
-
getGeoSearchDebugInfo
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.GeoSearchDebugInfo geo_search_debug_info = 16;- Specified by:
getGeoSearchDebugInfoin interfaceSearchResponseOrBuilder
-
getGeoSearchDebugInfoOrBuilder
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.GeoSearchDebugInfo geo_search_debug_info = 16;- Specified by:
getGeoSearchDebugInfoOrBuilderin interfaceSearchResponseOrBuilder
-
hasQueryExpansionInfo
public boolean hasQueryExpansionInfo()Query expansion information for the returned results.
.google.cloud.discoveryengine.v1beta.SearchResponse.QueryExpansionInfo query_expansion_info = 14;- Specified by:
hasQueryExpansionInfoin interfaceSearchResponseOrBuilder- Returns:
- Whether the queryExpansionInfo field is set.
-
getQueryExpansionInfo
Query expansion information for the returned results.
.google.cloud.discoveryengine.v1beta.SearchResponse.QueryExpansionInfo query_expansion_info = 14;- Specified by:
getQueryExpansionInfoin interfaceSearchResponseOrBuilder- Returns:
- The queryExpansionInfo.
-
getQueryExpansionInfoOrBuilder
Query expansion information for the returned results.
.google.cloud.discoveryengine.v1beta.SearchResponse.QueryExpansionInfo query_expansion_info = 14;- Specified by:
getQueryExpansionInfoOrBuilderin interfaceSearchResponseOrBuilder
-
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;- Specified by:
hasNaturalLanguageQueryUnderstandingInfoin interfaceSearchResponseOrBuilder- Returns:
- Whether the naturalLanguageQueryUnderstandingInfo field is set.
-
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;- Specified by:
getNaturalLanguageQueryUnderstandingInfoin interfaceSearchResponseOrBuilder- Returns:
- The naturalLanguageQueryUnderstandingInfo.
-
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;- Specified by:
getNaturalLanguageQueryUnderstandingInfoOrBuilderin interfaceSearchResponseOrBuilder
-
hasSessionInfo
public boolean hasSessionInfo()Session information. Only set if [SearchRequest.session][google.cloud.discoveryengine.v1beta.SearchRequest.session] is provided. See its description for more details.
.google.cloud.discoveryengine.v1beta.SearchResponse.SessionInfo session_info = 19;- Specified by:
hasSessionInfoin interfaceSearchResponseOrBuilder- Returns:
- Whether the sessionInfo field is set.
-
getSessionInfo
Session information. Only set if [SearchRequest.session][google.cloud.discoveryengine.v1beta.SearchRequest.session] is provided. See its description for more details.
.google.cloud.discoveryengine.v1beta.SearchResponse.SessionInfo session_info = 19;- Specified by:
getSessionInfoin interfaceSearchResponseOrBuilder- Returns:
- The sessionInfo.
-
getSessionInfoOrBuilder
Session information. Only set if [SearchRequest.session][google.cloud.discoveryengine.v1beta.SearchRequest.session] is provided. See its description for more details.
.google.cloud.discoveryengine.v1beta.SearchResponse.SessionInfo session_info = 19;- Specified by:
getSessionInfoOrBuilderin interfaceSearchResponseOrBuilder
-
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;- Specified by:
getOneBoxResultsListin interfaceSearchResponseOrBuilder
-
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;- Specified by:
getOneBoxResultsOrBuilderListin interfaceSearchResponseOrBuilder
-
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;- Specified by:
getOneBoxResultsCountin interfaceSearchResponseOrBuilder
-
getOneBoxResults
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;- Specified by:
getOneBoxResultsin interfaceSearchResponseOrBuilder
-
getOneBoxResultsOrBuilder
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;- Specified by:
getOneBoxResultsOrBuilderin interfaceSearchResponseOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static SearchResponse parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SearchResponse parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SearchResponse parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SearchResponse parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SearchResponse parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static SearchResponse parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static SearchResponse parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static SearchResponse parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static SearchResponse parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static SearchResponse parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected SearchResponse.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-