com.google.cloud.discoveryengine.v1beta

Class SearchResponse

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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

public final class SearchResponse
extends com.google.protobuf.GeneratedMessageV3
implements SearchResponseOrBuilder

 Response message for
 [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
 method.
 

Protobuf type google.cloud.discoveryengine.v1beta.SearchResponse

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchResponse.Builder Response message for [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] method.
static class	SearchResponse.Facet A facet result.
static interface	SearchResponse.FacetOrBuilder
static class	SearchResponse.GeoSearchDebugInfo Debug information specifically related to forward geocoding issues arising from Geolocation Search.
static interface	SearchResponse.GeoSearchDebugInfoOrBuilder
static class	SearchResponse.GuidedSearchResult Guided search result.
static interface	SearchResponse.GuidedSearchResultOrBuilder
static class	SearchResponse.NaturalLanguageQueryUnderstandingInfo Information describing what natural language understanding was done on the input query.
static interface	SearchResponse.NaturalLanguageQueryUnderstandingInfoOrBuilder
static class	SearchResponse.OneBoxResult OneBoxResult is a holder for all results of specific type that we want to display in UI differently.
static interface	SearchResponse.OneBoxResultOrBuilder
static class	SearchResponse.QueryExpansionInfo Information describing query expansion including whether expansion has occurred.
static interface	SearchResponse.QueryExpansionInfoOrBuilder
static class	SearchResponse.SearchResult Represents the search results.
static interface	SearchResponse.SearchResultOrBuilder
static class	SearchResponse.SessionInfo Information about the session.
static interface	SearchResponse.SessionInfoOrBuilder
static class	SearchResponse.Summary Summary of the top N search results specified by the summary spec.
static interface	SearchResponse.SummaryOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	APPLIED_CONTROLS_FIELD_NUMBER
static int	ATTRIBUTION_TOKEN_FIELD_NUMBER
static int	CORRECTED_QUERY_FIELD_NUMBER
static int	FACETS_FIELD_NUMBER
static int	GEO_SEARCH_DEBUG_INFO_FIELD_NUMBER
static int	GUIDED_SEARCH_RESULT_FIELD_NUMBER
static int	NATURAL_LANGUAGE_QUERY_UNDERSTANDING_INFO_FIELD_NUMBER
static int	NEXT_PAGE_TOKEN_FIELD_NUMBER
static int	ONE_BOX_RESULTS_FIELD_NUMBER
static int	QUERY_EXPANSION_INFO_FIELD_NUMBER
static int	REDIRECT_URI_FIELD_NUMBER
static int	RESULTS_FIELD_NUMBER
static int	SESSION_INFO_FIELD_NUMBER
static int	SUMMARY_FIELD_NUMBER
static int	TOTAL_SIZE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAppliedControls(int index) Controls applied as part of the Control service.
com.google.protobuf.ByteString	getAppliedControlsBytes(int index) Controls applied as part of the Control service.
int	getAppliedControlsCount() Controls applied as part of the Control service.
com.google.protobuf.ProtocolStringList	getAppliedControlsList() Controls applied as part of the Control service.
String	getAttributionToken() A unique search token.
com.google.protobuf.ByteString	getAttributionTokenBytes() A unique search token.
String	getCorrectedQuery() Contains the spell corrected query, if found.
com.google.protobuf.ByteString	getCorrectedQueryBytes() Contains the spell corrected query, if found.
static SearchResponse	getDefaultInstance()
SearchResponse	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
SearchResponse.Facet	getFacets(int index) Results of facets requested by user.
int	getFacetsCount() Results of facets requested by user.
List<SearchResponse.Facet>	getFacetsList() Results of facets requested by user.
SearchResponse.FacetOrBuilder	getFacetsOrBuilder(int index) Results of facets requested by user.
List<? extends SearchResponse.FacetOrBuilder>	getFacetsOrBuilderList() Results of facets requested by user.
SearchResponse.GeoSearchDebugInfo	getGeoSearchDebugInfo(int index) repeated .google.cloud.discoveryengine.v1beta.SearchResponse.GeoSearchDebugInfo geo_search_debug_info = 16;
int	getGeoSearchDebugInfoCount() repeated .google.cloud.discoveryengine.v1beta.SearchResponse.GeoSearchDebugInfo geo_search_debug_info = 16;
List<SearchResponse.GeoSearchDebugInfo>	getGeoSearchDebugInfoList() repeated .google.cloud.discoveryengine.v1beta.SearchResponse.GeoSearchDebugInfo geo_search_debug_info = 16;
SearchResponse.GeoSearchDebugInfoOrBuilder	getGeoSearchDebugInfoOrBuilder(int index) repeated .google.cloud.discoveryengine.v1beta.SearchResponse.GeoSearchDebugInfo geo_search_debug_info = 16;
List<? extends SearchResponse.GeoSearchDebugInfoOrBuilder>	getGeoSearchDebugInfoOrBuilderList() repeated .google.cloud.discoveryengine.v1beta.SearchResponse.GeoSearchDebugInfo geo_search_debug_info = 16;
SearchResponse.GuidedSearchResult	getGuidedSearchResult() Guided search result.
SearchResponse.GuidedSearchResultOrBuilder	getGuidedSearchResultOrBuilder() Guided search result.
SearchResponse.NaturalLanguageQueryUnderstandingInfo	getNaturalLanguageQueryUnderstandingInfo() Natural language query understanding information for the returned results.
SearchResponse.NaturalLanguageQueryUnderstandingInfoOrBuilder	getNaturalLanguageQueryUnderstandingInfoOrBuilder() Natural language query understanding information for the returned results.
String	getNextPageToken() 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.ByteString	getNextPageTokenBytes() A token that can be sent as [SearchRequest.page_token][google.cloud.discoveryengine.v1beta.SearchRequest.page_token] to retrieve the next page.
SearchResponse.OneBoxResult	getOneBoxResults(int index) A list of One Box results.
int	getOneBoxResultsCount() A list of One Box results.
List<SearchResponse.OneBoxResult>	getOneBoxResultsList() A list of One Box results.
SearchResponse.OneBoxResultOrBuilder	getOneBoxResultsOrBuilder(int index) A list of One Box results.
List<? extends SearchResponse.OneBoxResultOrBuilder>	getOneBoxResultsOrBuilderList() A list of One Box results.
com.google.protobuf.Parser<SearchResponse>	getParserForType()
SearchResponse.QueryExpansionInfo	getQueryExpansionInfo() Query expansion information for the returned results.
SearchResponse.QueryExpansionInfoOrBuilder	getQueryExpansionInfoOrBuilder() Query expansion information for the returned results.
String	getRedirectUri() The URI of a customer-defined redirect page.
com.google.protobuf.ByteString	getRedirectUriBytes() The URI of a customer-defined redirect page.
SearchResponse.SearchResult	getResults(int index) A list of matched documents.
int	getResultsCount() A list of matched documents.
List<SearchResponse.SearchResult>	getResultsList() A list of matched documents.
SearchResponse.SearchResultOrBuilder	getResultsOrBuilder(int index) A list of matched documents.
List<? extends SearchResponse.SearchResultOrBuilder>	getResultsOrBuilderList() A list of matched documents.
int	getSerializedSize()
SearchResponse.SessionInfo	getSessionInfo() Session information.
SearchResponse.SessionInfoOrBuilder	getSessionInfoOrBuilder() Session information.
SearchResponse.Summary	getSummary() A summary as part of the search results.
SearchResponse.SummaryOrBuilder	getSummaryOrBuilder() A summary as part of the search results.
int	getTotalSize() The estimated total count of matched items irrespective of pagination.
boolean	hasGuidedSearchResult() Guided search result.
int	hashCode()
boolean	hasNaturalLanguageQueryUnderstandingInfo() Natural language query understanding information for the returned results.
boolean	hasQueryExpansionInfo() Query expansion information for the returned results.
boolean	hasSessionInfo() Session information.
boolean	hasSummary() A summary as part of the search results.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static SearchResponse.Builder	newBuilder()
static SearchResponse.Builder	newBuilder(SearchResponse prototype)
SearchResponse.Builder	newBuilderForType()
protected SearchResponse.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static SearchResponse	parseDelimitedFrom(InputStream input)
static SearchResponse	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchResponse	parseFrom(byte[] data)
static SearchResponse	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchResponse	parseFrom(ByteBuffer data)
static SearchResponse	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchResponse	parseFrom(com.google.protobuf.ByteString data)
static SearchResponse	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchResponse	parseFrom(com.google.protobuf.CodedInputStream input)
static SearchResponse	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchResponse	parseFrom(InputStream input)
static SearchResponse	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SearchResponse>	parser()
SearchResponse.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

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, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

RESULTS_FIELD_NUMBER

public static final int RESULTS_FIELD_NUMBER

See Also:

Constant Field Values

FACETS_FIELD_NUMBER

public static final int FACETS_FIELD_NUMBER

See Also:

Constant Field Values

GUIDED_SEARCH_RESULT_FIELD_NUMBER

public static final int GUIDED_SEARCH_RESULT_FIELD_NUMBER

See Also:

Constant Field Values

TOTAL_SIZE_FIELD_NUMBER

public static final int TOTAL_SIZE_FIELD_NUMBER

See Also:

Constant Field Values

ATTRIBUTION_TOKEN_FIELD_NUMBER

public static final int ATTRIBUTION_TOKEN_FIELD_NUMBER

See Also:

Constant Field Values

REDIRECT_URI_FIELD_NUMBER

public static final int REDIRECT_URI_FIELD_NUMBER

See Also:

Constant Field Values

NEXT_PAGE_TOKEN_FIELD_NUMBER

public static final int NEXT_PAGE_TOKEN_FIELD_NUMBER

See Also:

Constant Field Values

CORRECTED_QUERY_FIELD_NUMBER

public static final int CORRECTED_QUERY_FIELD_NUMBER

See Also:

Constant Field Values

SUMMARY_FIELD_NUMBER

public static final int SUMMARY_FIELD_NUMBER

See Also:

Constant Field Values

APPLIED_CONTROLS_FIELD_NUMBER

public static final int APPLIED_CONTROLS_FIELD_NUMBER

See Also:

Constant Field Values

GEO_SEARCH_DEBUG_INFO_FIELD_NUMBER

public static final int GEO_SEARCH_DEBUG_INFO_FIELD_NUMBER

See Also:

Constant Field Values

QUERY_EXPANSION_INFO_FIELD_NUMBER

public static final int QUERY_EXPANSION_INFO_FIELD_NUMBER

See Also:

Constant Field Values

NATURAL_LANGUAGE_QUERY_UNDERSTANDING_INFO_FIELD_NUMBER

public static final int NATURAL_LANGUAGE_QUERY_UNDERSTANDING_INFO_FIELD_NUMBER

See Also:

Constant Field Values

SESSION_INFO_FIELD_NUMBER

public static final int SESSION_INFO_FIELD_NUMBER

See Also:

Constant Field Values

ONE_BOX_RESULTS_FIELD_NUMBER

public static final int ONE_BOX_RESULTS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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;

Specified by:

getResultsList in interface SearchResponseOrBuilder

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;

Specified by:

getResultsOrBuilderList in interface SearchResponseOrBuilder

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:

getResultsCount in interface SearchResponseOrBuilder

getResults

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;

Specified by:

getResults in interface SearchResponseOrBuilder

getResultsOrBuilder

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;

Specified by:

getResultsOrBuilder in interface SearchResponseOrBuilder

getFacetsList

public List<SearchResponse.Facet> getFacetsList()

 Results of facets requested by user.
 

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

Specified by:

getFacetsList in interface SearchResponseOrBuilder

getFacetsOrBuilderList

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

 Results of facets requested by user.
 

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

Specified by:

getFacetsOrBuilderList in interface SearchResponseOrBuilder

getFacetsCount

public int getFacetsCount()

 Results of facets requested by user.
 

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

Specified by:

getFacetsCount in interface SearchResponseOrBuilder

getFacets

public SearchResponse.Facet getFacets(int index)

 Results of facets requested by user.
 

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

Specified by:

getFacets in interface SearchResponseOrBuilder

getFacetsOrBuilder

public SearchResponse.FacetOrBuilder getFacetsOrBuilder(int index)

 Results of facets requested by user.
 

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

Specified by:

getFacetsOrBuilder in interface SearchResponseOrBuilder

hasGuidedSearchResult

public boolean hasGuidedSearchResult()

 Guided search result.
 

.google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult guided_search_result = 8;

Specified by:

hasGuidedSearchResult in interface SearchResponseOrBuilder

Returns:

Whether the guidedSearchResult field is set.

getGuidedSearchResult

public SearchResponse.GuidedSearchResult getGuidedSearchResult()

 Guided search result.
 

.google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult guided_search_result = 8;

Specified by:

getGuidedSearchResult in interface SearchResponseOrBuilder

Returns:

The guidedSearchResult.

getGuidedSearchResultOrBuilder

public SearchResponse.GuidedSearchResultOrBuilder getGuidedSearchResultOrBuilder()

 Guided search result.
 

.google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult guided_search_result = 8;

Specified by:

getGuidedSearchResultOrBuilder in interface SearchResponseOrBuilder

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:

getTotalSize in interface SearchResponseOrBuilder

Returns:

The totalSize.

getAttributionToken

public String 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:

getAttributionToken in interface SearchResponseOrBuilder

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:

getAttributionTokenBytes in interface SearchResponseOrBuilder

Returns:

The bytes for attributionToken.

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][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:

getRedirectUri in interface SearchResponseOrBuilder

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:

getRedirectUriBytes in interface SearchResponseOrBuilder

Returns:

The bytes for redirectUri.

getNextPageToken

public String 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:

getNextPageToken in interface SearchResponseOrBuilder

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:

getNextPageTokenBytes in interface SearchResponseOrBuilder

Returns:

The bytes for nextPageToken.

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;

Specified by:

getCorrectedQuery in interface SearchResponseOrBuilder

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:

getCorrectedQueryBytes in interface SearchResponseOrBuilder

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:

hasSummary in interface SearchResponseOrBuilder

Returns:

Whether the summary field is set.

getSummary

public SearchResponse.Summary 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:

getSummary in interface SearchResponseOrBuilder

Returns:

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][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.summary_spec]
 is set.
 

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

Specified by:

getSummaryOrBuilder in interface SearchResponseOrBuilder

getAppliedControlsList

public com.google.protobuf.ProtocolStringList getAppliedControlsList()

 Controls applied as part of the Control service.
 

repeated string applied_controls = 10;

Specified by:

getAppliedControlsList in interface SearchResponseOrBuilder

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:

getAppliedControlsCount in interface SearchResponseOrBuilder

Returns:

The count of appliedControls.

getAppliedControls

public String getAppliedControls(int index)

 Controls applied as part of the Control service.
 

repeated string applied_controls = 10;

Specified by:

getAppliedControls in interface SearchResponseOrBuilder

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:

getAppliedControlsBytes in interface SearchResponseOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the appliedControls at the given index.

getGeoSearchDebugInfoList

public List<SearchResponse.GeoSearchDebugInfo> getGeoSearchDebugInfoList()

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.GeoSearchDebugInfo geo_search_debug_info = 16;

Specified by:

getGeoSearchDebugInfoList in interface SearchResponseOrBuilder

getGeoSearchDebugInfoOrBuilderList

public List<? extends SearchResponse.GeoSearchDebugInfoOrBuilder> getGeoSearchDebugInfoOrBuilderList()

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.GeoSearchDebugInfo geo_search_debug_info = 16;

Specified by:

getGeoSearchDebugInfoOrBuilderList in interface SearchResponseOrBuilder

getGeoSearchDebugInfoCount

public int getGeoSearchDebugInfoCount()

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.GeoSearchDebugInfo geo_search_debug_info = 16;

Specified by:

getGeoSearchDebugInfoCount in interface SearchResponseOrBuilder

getGeoSearchDebugInfo

public SearchResponse.GeoSearchDebugInfo getGeoSearchDebugInfo(int index)

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.GeoSearchDebugInfo geo_search_debug_info = 16;

Specified by:

getGeoSearchDebugInfo in interface SearchResponseOrBuilder

getGeoSearchDebugInfoOrBuilder

public SearchResponse.GeoSearchDebugInfoOrBuilder getGeoSearchDebugInfoOrBuilder(int index)

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.GeoSearchDebugInfo geo_search_debug_info = 16;

Specified by:

getGeoSearchDebugInfoOrBuilder in interface SearchResponseOrBuilder

hasQueryExpansionInfo

public boolean hasQueryExpansionInfo()

 Query expansion information for the returned results.
 

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

Specified by:

hasQueryExpansionInfo in interface SearchResponseOrBuilder

Returns:

Whether the queryExpansionInfo field is set.

getQueryExpansionInfo

public SearchResponse.QueryExpansionInfo getQueryExpansionInfo()

 Query expansion information for the returned results.
 

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

Specified by:

getQueryExpansionInfo in interface SearchResponseOrBuilder

Returns:

The queryExpansionInfo.

getQueryExpansionInfoOrBuilder

public SearchResponse.QueryExpansionInfoOrBuilder getQueryExpansionInfoOrBuilder()

 Query expansion information for the returned results.
 

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

Specified by:

getQueryExpansionInfoOrBuilder in interface SearchResponseOrBuilder

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:

hasNaturalLanguageQueryUnderstandingInfo in interface SearchResponseOrBuilder

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:

getNaturalLanguageQueryUnderstandingInfo in interface SearchResponseOrBuilder

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:

getNaturalLanguageQueryUnderstandingInfoOrBuilder in interface SearchResponseOrBuilder

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:

hasSessionInfo in interface SearchResponseOrBuilder

Returns:

Whether the sessionInfo field is set.

getSessionInfo

public SearchResponse.SessionInfo 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:

getSessionInfo in interface SearchResponseOrBuilder

Returns:

The sessionInfo.

getSessionInfoOrBuilder

public SearchResponse.SessionInfoOrBuilder 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:

getSessionInfoOrBuilder in interface SearchResponseOrBuilder

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;

Specified by:

getOneBoxResultsList in interface SearchResponseOrBuilder

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;

Specified by:

getOneBoxResultsOrBuilderList in interface SearchResponseOrBuilder

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:

getOneBoxResultsCount in interface SearchResponseOrBuilder

getOneBoxResults

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;

Specified by:

getOneBoxResults in interface SearchResponseOrBuilder

getOneBoxResultsOrBuilder

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;

Specified by:

getOneBoxResultsOrBuilder in interface SearchResponseOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.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

public static SearchResponse parseFrom(InputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static SearchResponse parseFrom(InputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static SearchResponse parseDelimitedFrom(InputStream input)
                                         throws IOException

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

public SearchResponse.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static SearchResponse.Builder newBuilder()

newBuilder

public static SearchResponse.Builder newBuilder(SearchResponse prototype)

toBuilder

public SearchResponse.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected SearchResponse.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static SearchResponse getDefaultInstance()

parser

public static com.google.protobuf.Parser<SearchResponse> parser()

getParserForType

public com.google.protobuf.Parser<SearchResponse> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public SearchResponse getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder