com.google.cloud.discoveryengine.v1beta

Interface SearchResponseOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

SearchResponse, SearchResponse.Builder

public interface SearchResponseOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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.
List<String>	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.
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.GuidedSearchResult	getGuidedSearchResult() Guided search result.
SearchResponse.GuidedSearchResultOrBuilder	getGuidedSearchResultOrBuilder() Guided search result.
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.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.
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.
boolean	hasQueryExpansionInfo() Query expansion information for the returned results.
boolean	hasSummary() A summary as part of the search results.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getResultsList

List<SearchResponse.SearchResult> getResultsList()

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

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

getResults

SearchResponse.SearchResult getResults(int index)

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

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

getResultsCount

int getResultsCount()

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

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

getResultsOrBuilderList

List<? extends SearchResponse.SearchResultOrBuilder> getResultsOrBuilderList()

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

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

getResultsOrBuilder

SearchResponse.SearchResultOrBuilder getResultsOrBuilder(int index)

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

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

getFacetsList

List<SearchResponse.Facet> getFacetsList()

 Results of facets requested by user.
 

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

getFacets

SearchResponse.Facet getFacets(int index)

 Results of facets requested by user.
 

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

getFacetsCount

int getFacetsCount()

 Results of facets requested by user.
 

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

getFacetsOrBuilderList

List<? extends SearchResponse.FacetOrBuilder> getFacetsOrBuilderList()

 Results of facets requested by user.
 

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

getFacetsOrBuilder

SearchResponse.FacetOrBuilder getFacetsOrBuilder(int index)

 Results of facets requested by user.
 

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

hasGuidedSearchResult

boolean hasGuidedSearchResult()

 Guided search result.
 

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

Returns:

Whether the guidedSearchResult field is set.

getGuidedSearchResult

SearchResponse.GuidedSearchResult getGuidedSearchResult()

 Guided search result.
 

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

Returns:

The guidedSearchResult.

getGuidedSearchResultOrBuilder

SearchResponse.GuidedSearchResultOrBuilder getGuidedSearchResultOrBuilder()

 Guided search result.
 

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

getTotalSize

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;

Returns:

The totalSize.

getAttributionToken

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.
 

string attribution_token = 4;

Returns:

The attributionToken.

getAttributionTokenBytes

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.
 

string attribution_token = 4;

Returns:

The bytes for attributionToken.

getRedirectUri

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;

Returns:

The redirectUri.

getRedirectUriBytes

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;

Returns:

The bytes for redirectUri.

getNextPageToken

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;

Returns:

The nextPageToken.

getNextPageTokenBytes

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;

Returns:

The bytes for nextPageToken.

getCorrectedQuery

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:

The correctedQuery.

getCorrectedQueryBytes

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;

Returns:

The bytes for correctedQuery.

hasSummary

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;

Returns:

Whether the summary field is set.

getSummary

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;

Returns:

The summary.

getSummaryOrBuilder

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;

getAppliedControlsList

List<String> getAppliedControlsList()

 Controls applied as part of the Control service.
 

repeated string applied_controls = 10;

Returns:

A list containing the appliedControls.

getAppliedControlsCount

int getAppliedControlsCount()

 Controls applied as part of the Control service.
 

repeated string applied_controls = 10;

Returns:

The count of appliedControls.

getAppliedControls

String getAppliedControls(int index)

 Controls applied as part of the Control service.
 

repeated string applied_controls = 10;

Parameters:

index - The index of the element to return.

Returns:

The appliedControls at the given index.

getAppliedControlsBytes

com.google.protobuf.ByteString getAppliedControlsBytes(int index)

 Controls applied as part of the Control service.
 

repeated string applied_controls = 10;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the appliedControls at the given index.

hasQueryExpansionInfo

boolean hasQueryExpansionInfo()

 Query expansion information for the returned results.
 

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

Returns:

Whether the queryExpansionInfo field is set.

getQueryExpansionInfo

SearchResponse.QueryExpansionInfo getQueryExpansionInfo()

 Query expansion information for the returned results.
 

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

Returns:

The queryExpansionInfo.

getQueryExpansionInfoOrBuilder

SearchResponse.QueryExpansionInfoOrBuilder getQueryExpansionInfoOrBuilder()

 Query expansion information for the returned results.
 

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