SearchResponseOrBuilder (proto-google-cloud-retail-v2 2.35.0 API)

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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getAppliedControls(int index)` The fully qualified resource name of applied [controls](https://cloud.google.com/retail/docs/serving-control-rules).
`com.google.protobuf.ByteString`	`getAppliedControlsBytes(int index)` The fully qualified resource name of applied [controls](https://cloud.google.com/retail/docs/serving-control-rules).
`int`	`getAppliedControlsCount()` The fully qualified resource name of applied [controls](https://cloud.google.com/retail/docs/serving-control-rules).
`List<String>`	`getAppliedControlsList()` The fully qualified resource name of applied [controls](https://cloud.google.com/retail/docs/serving-control-rules).
`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.
`ExperimentInfo`	`getExperimentInfo(int index)` Metadata related to A/B testing [Experiment][] associated with this response.
`int`	`getExperimentInfoCount()` Metadata related to A/B testing [Experiment][] associated with this response.
`List<ExperimentInfo>`	`getExperimentInfoList()` Metadata related to A/B testing [Experiment][] associated with this response.
`ExperimentInfoOrBuilder`	`getExperimentInfoOrBuilder(int index)` Metadata related to A/B testing [Experiment][] associated with this response.
`List<? extends ExperimentInfoOrBuilder>`	`getExperimentInfoOrBuilderList()` Metadata related to A/B testing [Experiment][] associated with this response.
`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.
`SearchRequest.BoostSpec.ConditionBoostSpec`	`getInvalidConditionBoostSpecs(int index)` The invalid [SearchRequest.BoostSpec.condition_boost_specs][google.cloud.retail.v2.SearchRequest.BoostSpec.condition_boost_specs] that are not applied during serving.
`int`	`getInvalidConditionBoostSpecsCount()` The invalid [SearchRequest.BoostSpec.condition_boost_specs][google.cloud.retail.v2.SearchRequest.BoostSpec.condition_boost_specs] that are not applied during serving.
`List<SearchRequest.BoostSpec.ConditionBoostSpec>`	`getInvalidConditionBoostSpecsList()` The invalid [SearchRequest.BoostSpec.condition_boost_specs][google.cloud.retail.v2.SearchRequest.BoostSpec.condition_boost_specs] that are not applied during serving.
`SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder`	`getInvalidConditionBoostSpecsOrBuilder(int index)` The invalid [SearchRequest.BoostSpec.condition_boost_specs][google.cloud.retail.v2.SearchRequest.BoostSpec.condition_boost_specs] that are not applied during serving.
`List<? extends SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder>`	`getInvalidConditionBoostSpecsOrBuilderList()` The invalid [SearchRequest.BoostSpec.condition_boost_specs][google.cloud.retail.v2.SearchRequest.BoostSpec.condition_boost_specs] that are not applied during serving.
`String`	`getNextPageToken()` A token that can be sent as [SearchRequest.page_token][google.cloud.retail.v2.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.retail.v2.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 items.
`int`	`getResultsCount()` A list of matched items.
`List<SearchResponse.SearchResult>`	`getResultsList()` A list of matched items.
`SearchResponse.SearchResultOrBuilder`	`getResultsOrBuilder(int index)` A list of matched items.
`List<? extends SearchResponse.SearchResultOrBuilder>`	`getResultsOrBuilderList()` A list of matched items.
`int`	`getTotalSize()` The estimated total count of matched items irrespective of pagination.
`boolean`	`hasQueryExpansionInfo()` Query expansion information for the returned 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 items. The order represents the ranking.

repeated .google.cloud.retail.v2.SearchResponse.SearchResult results = 1;

getResults

SearchResponse.SearchResult getResults(int index)

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

repeated .google.cloud.retail.v2.SearchResponse.SearchResult results = 1;

getResultsCount
```
int getResultsCount()
```
```
 A list of matched items. The order represents the ranking.
 
```
repeated .google.cloud.retail.v2.SearchResponse.SearchResult results = 1;

getResultsOrBuilderList

List<? extends SearchResponse.SearchResultOrBuilder> getResultsOrBuilderList()

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

repeated .google.cloud.retail.v2.SearchResponse.SearchResult results = 1;

getResultsOrBuilder

SearchResponse.SearchResultOrBuilder getResultsOrBuilder(int index)

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

repeated .google.cloud.retail.v2.SearchResponse.SearchResult results = 1;

getFacetsList

List<SearchResponse.Facet> getFacetsList()

 Results of facets requested by user.

repeated .google.cloud.retail.v2.SearchResponse.Facet facets = 2;

getFacets

SearchResponse.Facet getFacets(int index)

 Results of facets requested by user.

repeated .google.cloud.retail.v2.SearchResponse.Facet facets = 2;

getFacetsCount
```
int getFacetsCount()
```
```
 Results of facets requested by user.
 
```
repeated .google.cloud.retail.v2.SearchResponse.Facet facets = 2;

getFacetsOrBuilderList

List<? extends SearchResponse.FacetOrBuilder> getFacetsOrBuilderList()

 Results of facets requested by user.

repeated .google.cloud.retail.v2.SearchResponse.Facet facets = 2;

getFacetsOrBuilder

SearchResponse.FacetOrBuilder getFacetsOrBuilder(int index)

 Results of facets requested by user.

repeated .google.cloud.retail.v2.SearchResponse.Facet facets = 2;

getTotalSize

int getTotalSize()

 The estimated total count of matched items irrespective of pagination. The
 count of [results][google.cloud.retail.v2.SearchResponse.results] returned
 by pagination may be less than the
 [total_size][google.cloud.retail.v2.SearchResponse.total_size] that
 matches.

int32 total_size = 3;

Returns:: The totalSize.

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 = 4;

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 = 4;

Returns:: The bytes for correctedQuery.

getAttributionToken

String getAttributionToken()

 A unique search token. This should be included in the
 [UserEvent][google.cloud.retail.v2.UserEvent] logs resulting from this
 search, which enables accurate attribution of search model performance.

string attribution_token = 5;

Returns:: The attributionToken.

getAttributionTokenBytes

com.google.protobuf.ByteString getAttributionTokenBytes()

 A unique search token. This should be included in the
 [UserEvent][google.cloud.retail.v2.UserEvent] logs resulting from this
 search, which enables accurate attribution of search model performance.

string attribution_token = 5;

Returns:: The bytes for attributionToken.

getNextPageToken

String getNextPageToken()

 A token that can be sent as
 [SearchRequest.page_token][google.cloud.retail.v2.SearchRequest.page_token]
 to retrieve the next page. If this field is omitted, there are no
 subsequent pages.

string next_page_token = 6;

Returns:: The nextPageToken.

getNextPageTokenBytes

com.google.protobuf.ByteString getNextPageTokenBytes()

 A token that can be sent as
 [SearchRequest.page_token][google.cloud.retail.v2.SearchRequest.page_token]
 to retrieve the next page. If this field is omitted, there are no
 subsequent pages.

string next_page_token = 6;

Returns:: The bytes for nextPageToken.

hasQueryExpansionInfo
```
boolean hasQueryExpansionInfo()
```
```
 Query expansion information for the returned results.
 
```
.google.cloud.retail.v2.SearchResponse.QueryExpansionInfo query_expansion_info = 7;
Returns:

Whether the queryExpansionInfo field is set.

getQueryExpansionInfo
```
SearchResponse.QueryExpansionInfo getQueryExpansionInfo()
```
```
 Query expansion information for the returned results.
 
```
.google.cloud.retail.v2.SearchResponse.QueryExpansionInfo query_expansion_info = 7;
Returns:

The queryExpansionInfo.

getQueryExpansionInfoOrBuilder

SearchResponse.QueryExpansionInfoOrBuilder getQueryExpansionInfoOrBuilder()

 Query expansion information for the returned results.

.google.cloud.retail.v2.SearchResponse.QueryExpansionInfo query_expansion_info = 7;

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.retail.v2.SearchResponse.redirect_uri] and
 [attribution_token][google.cloud.retail.v2.SearchResponse.attribution_token]
 are set in the response.

string redirect_uri = 10;

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.retail.v2.SearchResponse.redirect_uri] and
 [attribution_token][google.cloud.retail.v2.SearchResponse.attribution_token]
 are set in the response.

string redirect_uri = 10;

Returns:: The bytes for redirectUri.

getAppliedControlsList

List<String> getAppliedControlsList()

 The fully qualified resource name of applied
 [controls](https://cloud.google.com/retail/docs/serving-control-rules).

repeated string applied_controls = 12;

Returns:: A list containing the appliedControls.

getAppliedControlsCount

int getAppliedControlsCount()

 The fully qualified resource name of applied
 [controls](https://cloud.google.com/retail/docs/serving-control-rules).

repeated string applied_controls = 12;

Returns:: The count of appliedControls.

getAppliedControls

String getAppliedControls(int index)

 The fully qualified resource name of applied
 [controls](https://cloud.google.com/retail/docs/serving-control-rules).

repeated string applied_controls = 12;

Parameters:: index - The index of the element to return.
Returns:: The appliedControls at the given index.

getAppliedControlsBytes

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

 The fully qualified resource name of applied
 [controls](https://cloud.google.com/retail/docs/serving-control-rules).

repeated string applied_controls = 12;

Parameters:: index - The index of the value to return.
Returns:: The bytes of the appliedControls at the given index.

getInvalidConditionBoostSpecsList

List<SearchRequest.BoostSpec.ConditionBoostSpec> getInvalidConditionBoostSpecsList()

 The invalid
 [SearchRequest.BoostSpec.condition_boost_specs][google.cloud.retail.v2.SearchRequest.BoostSpec.condition_boost_specs]
 that are not applied during serving.


 repeated .google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec invalid_condition_boost_specs = 14;

getInvalidConditionBoostSpecs

SearchRequest.BoostSpec.ConditionBoostSpec getInvalidConditionBoostSpecs(int index)

 The invalid
 [SearchRequest.BoostSpec.condition_boost_specs][google.cloud.retail.v2.SearchRequest.BoostSpec.condition_boost_specs]
 that are not applied during serving.


 repeated .google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec invalid_condition_boost_specs = 14;

getInvalidConditionBoostSpecsCount

int getInvalidConditionBoostSpecsCount()

 The invalid
 [SearchRequest.BoostSpec.condition_boost_specs][google.cloud.retail.v2.SearchRequest.BoostSpec.condition_boost_specs]
 that are not applied during serving.


 repeated .google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec invalid_condition_boost_specs = 14;

getInvalidConditionBoostSpecsOrBuilderList

List<? extends SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder> getInvalidConditionBoostSpecsOrBuilderList()

 The invalid
 [SearchRequest.BoostSpec.condition_boost_specs][google.cloud.retail.v2.SearchRequest.BoostSpec.condition_boost_specs]
 that are not applied during serving.


 repeated .google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec invalid_condition_boost_specs = 14;

getInvalidConditionBoostSpecsOrBuilder

SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder getInvalidConditionBoostSpecsOrBuilder(int index)

 The invalid
 [SearchRequest.BoostSpec.condition_boost_specs][google.cloud.retail.v2.SearchRequest.BoostSpec.condition_boost_specs]
 that are not applied during serving.


 repeated .google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec invalid_condition_boost_specs = 14;