Class SearchResponse (0.90.0)

0.90.0 (latest) 0.89.0 0.87.0 0.84.0 0.83.0 0.81.0 0.79.0 0.78.0 0.77.0 0.76.0 0.74.0 0.72.0 0.71.0 0.70.0 0.69.0 0.68.0 0.66.0 0.64.0 0.63.0 0.60.0 0.59.0 0.58.0 0.56.0 0.55.0 0.54.0 0.53.0 0.52.0 0.51.0 0.50.0 0.49.0 0.48.0 0.47.0 0.45.0 0.44.0 0.43.0 0.42.0 0.41.0 0.40.0 0.39.0 0.38.0 0.37.0 0.36.0 0.35.0 0.33.0 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.0 0.25.0 0.24.0 0.23.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

public final class SearchResponse extends GeneratedMessage implements SearchResponseOrBuilder

Response message for SearchService.Search method.

Protobuf type google.cloud.discoveryengine.v1beta.SearchResponse

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > SearchResponse

Implements

SearchResponseOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,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

SEARCH_LINK_PROMOTIONS_FIELD_NUMBER

public static final int SEARCH_LINK_PROMOTIONS_FIELD_NUMBER

Field Value
Type	Description
int

SEMANTIC_STATE_FIELD_NUMBER

public static final int SEMANTIC_STATE_FIELD_NUMBER

Field Value
Type	Description
int

SESSION_INFO_FIELD_NUMBER

public static final int SESSION_INFO_FIELD_NUMBER

Field Value
Type	Description
int

SUGGESTED_QUERY_FIELD_NUMBER

public static final int SUGGESTED_QUERY_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()

Returns
Type	Description
SearchResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static SearchResponse.Builder newBuilder()

Returns
Type	Description
SearchResponse.Builder

newBuilder(SearchResponse prototype)

public static SearchResponse.Builder newBuilder(SearchResponse prototype)

Parameter
Name	Description
prototype	SearchResponse

Returns
Type	Description
SearchResponse.Builder

parseDelimitedFrom(InputStream input)

public static SearchResponse parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
SearchResponse

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchResponse

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static SearchResponse parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
SearchResponse

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchResponse

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchResponse parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
SearchResponse

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchResponse

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchResponse parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
SearchResponse

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchResponse

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static SearchResponse parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
SearchResponse

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchResponse

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static SearchResponse parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
SearchResponse

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchResponse

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<SearchResponse> parser()

Returns
Type	Description
Parser<SearchResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

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;

Returns
Type	Description
ProtocolStringList	A list containing the appliedControls.

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()

Returns
Type	Description
SearchResponse

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

Returns
Type	Description
SearchResponse.Facet

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;

Returns
Type	Description
List<Facet>

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

Returns
Type	Description
SearchResponse.FacetOrBuilder

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

Returns
Type	Description
SearchResponse.GeoSearchDebugInfo

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;

Returns
Type	Description
List<GeoSearchDebugInfo>

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

Returns
Type	Description
SearchResponse.GeoSearchDebugInfoOrBuilder

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;

Returns
Type	Description
SearchResponse.GuidedSearchResult	The guidedSearchResult.

getGuidedSearchResultOrBuilder()

public SearchResponse.GuidedSearchResultOrBuilder getGuidedSearchResultOrBuilder()

Guided search result.

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

Returns
Type	Description
SearchResponse.GuidedSearchResultOrBuilder

getNaturalLanguageQueryUnderstandingInfo()

public SearchResponse.NaturalLanguageQueryUnderstandingInfo getNaturalLanguageQueryUnderstandingInfo()

Output only. Natural language query understanding information for the returned results.

.google.cloud.discoveryengine.v1beta.SearchResponse.NaturalLanguageQueryUnderstandingInfo natural_language_query_understanding_info = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
SearchResponse.NaturalLanguageQueryUnderstandingInfo	The naturalLanguageQueryUnderstandingInfo.

getNaturalLanguageQueryUnderstandingInfoOrBuilder()

public SearchResponse.NaturalLanguageQueryUnderstandingInfoOrBuilder getNaturalLanguageQueryUnderstandingInfoOrBuilder()

Output only. Natural language query understanding information for the returned results.

.google.cloud.discoveryengine.v1beta.SearchResponse.NaturalLanguageQueryUnderstandingInfo natural_language_query_understanding_info = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
SearchResponse.NaturalLanguageQueryUnderstandingInfoOrBuilder

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

Returns
Type	Description
SearchResponse.OneBoxResult

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;

Returns
Type	Description
List<OneBoxResult>

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

Returns
Type	Description
SearchResponse.OneBoxResultOrBuilder

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()

Returns
Type	Description
Parser<SearchResponse>

Overrides

GeneratedMessage.getParserForType()

getQueryExpansionInfo()

public SearchResponse.QueryExpansionInfo getQueryExpansionInfo()

Query expansion information for the returned results.

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

Returns
Type	Description
SearchResponse.QueryExpansionInfo	The queryExpansionInfo.

getQueryExpansionInfoOrBuilder()

public SearchResponse.QueryExpansionInfoOrBuilder getQueryExpansionInfoOrBuilder()

Query expansion information for the returned results.

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

Returns
Type	Description
SearchResponse.QueryExpansionInfoOrBuilder

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

Returns
Type	Description
SearchResponse.SearchResult

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;

Returns
Type	Description
List<SearchResult>

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

Returns
Type	Description
SearchResponse.SearchResultOrBuilder

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>

getSearchLinkPromotions(int index)

public SearchLinkPromotion getSearchLinkPromotions(int index)

Promotions for site search.

repeated .google.cloud.discoveryengine.v1beta.SearchLinkPromotion search_link_promotions = 23;

Parameter
Name	Description
index	int

Returns
Type	Description
SearchLinkPromotion

getSearchLinkPromotionsCount()

public int getSearchLinkPromotionsCount()

Promotions for site search.

repeated .google.cloud.discoveryengine.v1beta.SearchLinkPromotion search_link_promotions = 23;

Returns
Type	Description
int

getSearchLinkPromotionsList()

public List<SearchLinkPromotion> getSearchLinkPromotionsList()

Promotions for site search.

repeated .google.cloud.discoveryengine.v1beta.SearchLinkPromotion search_link_promotions = 23;

Returns
Type	Description
List<SearchLinkPromotion>

getSearchLinkPromotionsOrBuilder(int index)

public SearchLinkPromotionOrBuilder getSearchLinkPromotionsOrBuilder(int index)

Promotions for site search.

repeated .google.cloud.discoveryengine.v1beta.SearchLinkPromotion search_link_promotions = 23;

Parameter
Name	Description
index	int

Returns
Type	Description
SearchLinkPromotionOrBuilder

getSearchLinkPromotionsOrBuilderList()

public List<? extends SearchLinkPromotionOrBuilder> getSearchLinkPromotionsOrBuilderList()

Promotions for site search.

repeated .google.cloud.discoveryengine.v1beta.SearchLinkPromotion search_link_promotions = 23;

Returns
Type	Description
List<? extends com.google.cloud.discoveryengine.v1beta.SearchLinkPromotionOrBuilder>

getSemanticState()

public SearchResponse.SemanticState getSemanticState()

Output only. Indicates the semantic state of the search response.

.google.cloud.discoveryengine.v1beta.SearchResponse.SemanticState semantic_state = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
SearchResponse.SemanticState	The semanticState.

getSemanticStateValue()

public int getSemanticStateValue()

Output only. Indicates the semantic state of the search response.

.google.cloud.discoveryengine.v1beta.SearchResponse.SemanticState semantic_state = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The enum numeric value on the wire for semanticState.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

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;

Returns
Type	Description
SearchResponse.SessionInfo	The sessionInfo.

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;

Returns
Type	Description
SearchResponse.SessionInfoOrBuilder

getSuggestedQuery()

public String getSuggestedQuery()

Corrected query with low confidence, AKA did you mean query. Compared with corrected_query, this field is set when SpellCorrector returned a response, but FPR(full page replacement) is not triggered because the corrction is of low confidence(eg, reversed because there are matches of the original query in document corpus).

string suggested_query = 24;

Returns
Type	Description
String	The suggestedQuery.

getSuggestedQueryBytes()

public ByteString getSuggestedQueryBytes()

Corrected query with low confidence, AKA did you mean query. Compared with corrected_query, this field is set when SpellCorrector returned a response, but FPR(full page replacement) is not triggered because the corrction is of low confidence(eg, reversed because there are matches of the original query in document corpus).

string suggested_query = 24;

Returns
Type	Description
ByteString	The bytes for suggestedQuery.

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;

Returns
Type	Description
SearchResponse.Summary	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 is set.

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

Returns
Type	Description
SearchResponse.SummaryOrBuilder

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()

Output only. Natural language query understanding information for the returned results.

.google.cloud.discoveryengine.v1beta.SearchResponse.NaturalLanguageQueryUnderstandingInfo natural_language_query_understanding_info = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

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()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public SearchResponse.Builder newBuilderForType()

Returns
Type	Description
SearchResponse.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected SearchResponse.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
SearchResponse.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public SearchResponse.Builder toBuilder()

Returns
Type	Description
SearchResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException