- 2.64.0 (latest)
- 2.62.0
- 2.61.0
- 2.60.0
- 2.59.0
- 2.58.0
- 2.57.0
- 2.56.0
- 2.55.0
- 2.54.0
- 2.53.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.1
- 2.4.0
- 2.3.0
- 2.2.3
- 2.1.0
- 2.0.19
public interface SearchResponseOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAppliedControls(int index)
public abstract String getAppliedControls(int index)The fully qualified resource name of applied controls.
repeated string applied_controls = 12;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The appliedControls at the given index. |
getAppliedControlsBytes(int index)
public abstract ByteString getAppliedControlsBytes(int index)The fully qualified resource name of applied controls.
repeated string applied_controls = 12;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the appliedControls at the given index. |
getAppliedControlsCount()
public abstract int getAppliedControlsCount()The fully qualified resource name of applied controls.
repeated string applied_controls = 12;
| Returns | |
|---|---|
| Type | Description |
int |
The count of appliedControls. |
getAppliedControlsList()
public abstract List<String> getAppliedControlsList()The fully qualified resource name of applied controls.
repeated string applied_controls = 12;
| Returns | |
|---|---|
| Type | Description |
List<String> |
A list containing the appliedControls. |
getAttributionToken()
public abstract 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.
string attribution_token = 5;
| Returns | |
|---|---|
| Type | Description |
String |
The attributionToken. |
getAttributionTokenBytes()
public abstract 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.
string attribution_token = 5;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for attributionToken. |
getConversationalSearchResult()
public abstract SearchResponse.ConversationalSearchResult getConversationalSearchResult()This field specifies all related information that is needed on client side for UI rendering of conversational retail search.
.google.cloud.retail.v2beta.SearchResponse.ConversationalSearchResult conversational_search_result = 18;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult |
The conversationalSearchResult. |
getConversationalSearchResultOrBuilder()
public abstract SearchResponse.ConversationalSearchResultOrBuilder getConversationalSearchResultOrBuilder()This field specifies all related information that is needed on client side for UI rendering of conversational retail search.
.google.cloud.retail.v2beta.SearchResponse.ConversationalSearchResult conversational_search_result = 18;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResultOrBuilder |
|
getCorrectedQuery()
public abstract 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 | |
|---|---|
| Type | Description |
String |
The correctedQuery. |
getCorrectedQueryBytes()
public abstract 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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for correctedQuery. |
getExperimentInfo(int index)
public abstract ExperimentInfo getExperimentInfo(int index)Metadata related to A/B testing experiment associated with this response. Only exists when an experiment is triggered.
repeated .google.cloud.retail.v2beta.ExperimentInfo experiment_info = 17;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ExperimentInfo |
|
getExperimentInfoCount()
public abstract int getExperimentInfoCount()Metadata related to A/B testing experiment associated with this response. Only exists when an experiment is triggered.
repeated .google.cloud.retail.v2beta.ExperimentInfo experiment_info = 17;
| Returns | |
|---|---|
| Type | Description |
int |
|
getExperimentInfoList()
public abstract List<ExperimentInfo> getExperimentInfoList()Metadata related to A/B testing experiment associated with this response. Only exists when an experiment is triggered.
repeated .google.cloud.retail.v2beta.ExperimentInfo experiment_info = 17;
| Returns | |
|---|---|
| Type | Description |
List<ExperimentInfo> |
|
getExperimentInfoOrBuilder(int index)
public abstract ExperimentInfoOrBuilder getExperimentInfoOrBuilder(int index)Metadata related to A/B testing experiment associated with this response. Only exists when an experiment is triggered.
repeated .google.cloud.retail.v2beta.ExperimentInfo experiment_info = 17;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ExperimentInfoOrBuilder |
|
getExperimentInfoOrBuilderList()
public abstract List<? extends ExperimentInfoOrBuilder> getExperimentInfoOrBuilderList()Metadata related to A/B testing experiment associated with this response. Only exists when an experiment is triggered.
repeated .google.cloud.retail.v2beta.ExperimentInfo experiment_info = 17;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.retail.v2beta.ExperimentInfoOrBuilder> |
|
getFacets(int index)
public abstract SearchResponse.Facet getFacets(int index)Results of facets requested by user.
repeated .google.cloud.retail.v2beta.SearchResponse.Facet facets = 2;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Facet |
|
getFacetsCount()
public abstract int getFacetsCount()Results of facets requested by user.
repeated .google.cloud.retail.v2beta.SearchResponse.Facet facets = 2;
| Returns | |
|---|---|
| Type | Description |
int |
|
getFacetsList()
public abstract List<SearchResponse.Facet> getFacetsList()Results of facets requested by user.
repeated .google.cloud.retail.v2beta.SearchResponse.Facet facets = 2;
| Returns | |
|---|---|
| Type | Description |
List<Facet> |
|
getFacetsOrBuilder(int index)
public abstract SearchResponse.FacetOrBuilder getFacetsOrBuilder(int index)Results of facets requested by user.
repeated .google.cloud.retail.v2beta.SearchResponse.Facet facets = 2;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.FacetOrBuilder |
|
getFacetsOrBuilderList()
public abstract List<? extends SearchResponse.FacetOrBuilder> getFacetsOrBuilderList()Results of facets requested by user.
repeated .google.cloud.retail.v2beta.SearchResponse.Facet facets = 2;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.retail.v2beta.SearchResponse.FacetOrBuilder> |
|
getInvalidConditionBoostSpecs(int index)
public abstract SearchRequest.BoostSpec.ConditionBoostSpec getInvalidConditionBoostSpecs(int index)The invalid SearchRequest.BoostSpec.condition_boost_specs that are not applied during serving.
repeated .google.cloud.retail.v2beta.SearchRequest.BoostSpec.ConditionBoostSpec invalid_condition_boost_specs = 14;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpec.ConditionBoostSpec |
|
getInvalidConditionBoostSpecsCount()
public abstract int getInvalidConditionBoostSpecsCount()The invalid SearchRequest.BoostSpec.condition_boost_specs that are not applied during serving.
repeated .google.cloud.retail.v2beta.SearchRequest.BoostSpec.ConditionBoostSpec invalid_condition_boost_specs = 14;
| Returns | |
|---|---|
| Type | Description |
int |
|
getInvalidConditionBoostSpecsList()
public abstract List<SearchRequest.BoostSpec.ConditionBoostSpec> getInvalidConditionBoostSpecsList()The invalid SearchRequest.BoostSpec.condition_boost_specs that are not applied during serving.
repeated .google.cloud.retail.v2beta.SearchRequest.BoostSpec.ConditionBoostSpec invalid_condition_boost_specs = 14;
| Returns | |
|---|---|
| Type | Description |
List<ConditionBoostSpec> |
|
getInvalidConditionBoostSpecsOrBuilder(int index)
public abstract SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder getInvalidConditionBoostSpecsOrBuilder(int index)The invalid SearchRequest.BoostSpec.condition_boost_specs that are not applied during serving.
repeated .google.cloud.retail.v2beta.SearchRequest.BoostSpec.ConditionBoostSpec invalid_condition_boost_specs = 14;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder |
|
getInvalidConditionBoostSpecsOrBuilderList()
public abstract List<? extends SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder> getInvalidConditionBoostSpecsOrBuilderList()The invalid SearchRequest.BoostSpec.condition_boost_specs that are not applied during serving.
repeated .google.cloud.retail.v2beta.SearchRequest.BoostSpec.ConditionBoostSpec invalid_condition_boost_specs = 14;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.retail.v2beta.SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder> |
|
getNextPageToken()
public abstract 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 = 6;
| Returns | |
|---|---|
| Type | Description |
String |
The nextPageToken. |
getNextPageTokenBytes()
public abstract 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 = 6;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for nextPageToken. |
getPinControlMetadata()
public abstract PinControlMetadata getPinControlMetadata()Metadata for pin controls which were applicable to the request. This contains two map fields, one for all matched pins and one for pins which were matched but not applied.
The two maps are keyed by pin position, and the values are the product ids which were matched to that pin.
.google.cloud.retail.v2beta.PinControlMetadata pin_control_metadata = 22;
| Returns | |
|---|---|
| Type | Description |
PinControlMetadata |
The pinControlMetadata. |
getPinControlMetadataOrBuilder()
public abstract PinControlMetadataOrBuilder getPinControlMetadataOrBuilder()Metadata for pin controls which were applicable to the request. This contains two map fields, one for all matched pins and one for pins which were matched but not applied.
The two maps are keyed by pin position, and the values are the product ids which were matched to that pin.
.google.cloud.retail.v2beta.PinControlMetadata pin_control_metadata = 22;
| Returns | |
|---|---|
| Type | Description |
PinControlMetadataOrBuilder |
|
getQueryExpansionInfo()
public abstract SearchResponse.QueryExpansionInfo getQueryExpansionInfo()Query expansion information for the returned results.
.google.cloud.retail.v2beta.SearchResponse.QueryExpansionInfo query_expansion_info = 7;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.QueryExpansionInfo |
The queryExpansionInfo. |
getQueryExpansionInfoOrBuilder()
public abstract SearchResponse.QueryExpansionInfoOrBuilder getQueryExpansionInfoOrBuilder()Query expansion information for the returned results.
.google.cloud.retail.v2beta.SearchResponse.QueryExpansionInfo query_expansion_info = 7;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.QueryExpansionInfoOrBuilder |
|
getRedirectUri()
public abstract 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 = 10;
| Returns | |
|---|---|
| Type | Description |
String |
The redirectUri. |
getRedirectUriBytes()
public abstract 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 = 10;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for redirectUri. |
getResults(int index)
public abstract SearchResponse.SearchResult getResults(int index)A list of matched items. The order represents the ranking.
repeated .google.cloud.retail.v2beta.SearchResponse.SearchResult results = 1;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult |
|
getResultsCount()
public abstract int getResultsCount()A list of matched items. The order represents the ranking.
repeated .google.cloud.retail.v2beta.SearchResponse.SearchResult results = 1;
| Returns | |
|---|---|
| Type | Description |
int |
|
getResultsList()
public abstract List<SearchResponse.SearchResult> getResultsList()A list of matched items. The order represents the ranking.
repeated .google.cloud.retail.v2beta.SearchResponse.SearchResult results = 1;
| Returns | |
|---|---|
| Type | Description |
List<SearchResult> |
|
getResultsOrBuilder(int index)
public abstract SearchResponse.SearchResultOrBuilder getResultsOrBuilder(int index)A list of matched items. The order represents the ranking.
repeated .google.cloud.retail.v2beta.SearchResponse.SearchResult results = 1;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResultOrBuilder |
|
getResultsOrBuilderList()
public abstract List<? extends SearchResponse.SearchResultOrBuilder> getResultsOrBuilderList()A list of matched items. The order represents the ranking.
repeated .google.cloud.retail.v2beta.SearchResponse.SearchResult results = 1;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.retail.v2beta.SearchResponse.SearchResultOrBuilder> |
|
getTileNavigationResult()
public abstract SearchResponse.TileNavigationResult getTileNavigationResult()This field specifies all related information for tile navigation that will be used in client side.
.google.cloud.retail.v2beta.SearchResponse.TileNavigationResult tile_navigation_result = 19;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.TileNavigationResult |
The tileNavigationResult. |
getTileNavigationResultOrBuilder()
public abstract SearchResponse.TileNavigationResultOrBuilder getTileNavigationResultOrBuilder()This field specifies all related information for tile navigation that will be used in client side.
.google.cloud.retail.v2beta.SearchResponse.TileNavigationResult tile_navigation_result = 19;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.TileNavigationResultOrBuilder |
|
getTotalSize()
public abstract 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. |
hasConversationalSearchResult()
public abstract boolean hasConversationalSearchResult()This field specifies all related information that is needed on client side for UI rendering of conversational retail search.
.google.cloud.retail.v2beta.SearchResponse.ConversationalSearchResult conversational_search_result = 18;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the conversationalSearchResult field is set. |
hasPinControlMetadata()
public abstract boolean hasPinControlMetadata()Metadata for pin controls which were applicable to the request. This contains two map fields, one for all matched pins and one for pins which were matched but not applied.
The two maps are keyed by pin position, and the values are the product ids which were matched to that pin.
.google.cloud.retail.v2beta.PinControlMetadata pin_control_metadata = 22;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the pinControlMetadata field is set. |
hasQueryExpansionInfo()
public abstract boolean hasQueryExpansionInfo()Query expansion information for the returned results.
.google.cloud.retail.v2beta.SearchResponse.QueryExpansionInfo query_expansion_info = 7;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the queryExpansionInfo field is set. |
hasTileNavigationResult()
public abstract boolean hasTileNavigationResult()This field specifies all related information for tile navigation that will be used in client side.
.google.cloud.retail.v2beta.SearchResponse.TileNavigationResult tile_navigation_result = 19;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the tileNavigationResult field is set. |