public final class SearchResponse extends GeneratedMessageV3 implements SearchResponseOrBuilder
Response message for
SearchService.Search method.
Protobuf type google.cloud.retail.v2.SearchResponse
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(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 |
|
CONVERSATIONAL_SEARCH_RESULT_FIELD_NUMBER
public static final int CONVERSATIONAL_SEARCH_RESULT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CORRECTED_QUERY_FIELD_NUMBER
public static final int CORRECTED_QUERY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
EXPERIMENT_INFO_FIELD_NUMBER
public static final int EXPERIMENT_INFO_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
FACETS_FIELD_NUMBER
public static final int FACETS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
INVALID_CONDITION_BOOST_SPECS_FIELD_NUMBER
public static final int INVALID_CONDITION_BOOST_SPECS_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 |
|
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 |
|
TILE_NAVIGATION_RESULT_FIELD_NUMBER
public static final int TILE_NAVIGATION_RESULT_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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static SearchResponse.Builder newBuilder()
newBuilder(SearchResponse prototype)
public static SearchResponse.Builder newBuilder(SearchResponse prototype)
public static SearchResponse parseDelimitedFrom(InputStream input)
public static SearchResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static SearchResponse parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static SearchResponse parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchResponse parseFrom(CodedInputStream input)
public static SearchResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchResponse parseFrom(InputStream input)
public static SearchResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static SearchResponse parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<SearchResponse> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAppliedControls(int index)
public String getAppliedControls(int index)
The fully qualified resource name of applied
controls.
repeated string applied_controls = 12;
| 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)
The fully qualified resource name of applied
controls.
repeated string applied_controls = 12;
| 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()
The fully qualified resource name of applied
controls.
repeated string applied_controls = 12;
| Returns |
| Type |
Description |
int |
The count of appliedControls.
|
getAppliedControlsList()
public ProtocolStringList getAppliedControlsList()
The fully qualified resource name of applied
controls.
repeated string applied_controls = 12;
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.
string attribution_token = 5;
| 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.
string attribution_token = 5;
| Returns |
| Type |
Description |
ByteString |
The bytes for attributionToken.
|
getConversationalSearchResult()
public 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.v2.SearchResponse.ConversationalSearchResult conversational_search_result = 18;
getConversationalSearchResultOrBuilder()
public 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.v2.SearchResponse.ConversationalSearchResult conversational_search_result = 18;
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 = 4;
| 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 = 4;
| Returns |
| Type |
Description |
ByteString |
The bytes for correctedQuery.
|
getDefaultInstanceForType()
public SearchResponse getDefaultInstanceForType()
getExperimentInfo(int index)
public 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.v2.ExperimentInfo experiment_info = 17;
| Parameter |
| Name |
Description |
index |
int
|
getExperimentInfoCount()
public int getExperimentInfoCount()
Metadata related to A/B testing [Experiment][] associated with this
response. Only exists when an experiment is triggered.
repeated .google.cloud.retail.v2.ExperimentInfo experiment_info = 17;
| Returns |
| Type |
Description |
int |
|
getExperimentInfoList()
public 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.v2.ExperimentInfo experiment_info = 17;
getExperimentInfoOrBuilder(int index)
public 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.v2.ExperimentInfo experiment_info = 17;
| Parameter |
| Name |
Description |
index |
int
|
getExperimentInfoOrBuilderList()
public 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.v2.ExperimentInfo experiment_info = 17;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.retail.v2.ExperimentInfoOrBuilder> |
|
getFacets(int index)
public SearchResponse.Facet getFacets(int index)
Results of facets requested by user.
repeated .google.cloud.retail.v2.SearchResponse.Facet facets = 2;
| Parameter |
| Name |
Description |
index |
int
|
getFacetsCount()
public int getFacetsCount()
Results of facets requested by user.
repeated .google.cloud.retail.v2.SearchResponse.Facet facets = 2;
| Returns |
| Type |
Description |
int |
|
getFacetsList()
public List<SearchResponse.Facet> getFacetsList()
Results of facets requested by user.
repeated .google.cloud.retail.v2.SearchResponse.Facet facets = 2;
getFacetsOrBuilder(int index)
public SearchResponse.FacetOrBuilder getFacetsOrBuilder(int index)
Results of facets requested by user.
repeated .google.cloud.retail.v2.SearchResponse.Facet facets = 2;
| Parameter |
| Name |
Description |
index |
int
|
getFacetsOrBuilderList()
public List<? extends SearchResponse.FacetOrBuilder> getFacetsOrBuilderList()
Results of facets requested by user.
repeated .google.cloud.retail.v2.SearchResponse.Facet facets = 2;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.retail.v2.SearchResponse.FacetOrBuilder> |
|
getInvalidConditionBoostSpecs(int index)
public SearchRequest.BoostSpec.ConditionBoostSpec getInvalidConditionBoostSpecs(int index)
The invalid
SearchRequest.BoostSpec.condition_boost_specs
that are not applied during serving.
repeated .google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec invalid_condition_boost_specs = 14;
| Parameter |
| Name |
Description |
index |
int
|
getInvalidConditionBoostSpecsCount()
public int getInvalidConditionBoostSpecsCount()
The invalid
SearchRequest.BoostSpec.condition_boost_specs
that are not applied during serving.
repeated .google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec invalid_condition_boost_specs = 14;
| Returns |
| Type |
Description |
int |
|
getInvalidConditionBoostSpecsList()
public List<SearchRequest.BoostSpec.ConditionBoostSpec> getInvalidConditionBoostSpecsList()
The invalid
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(int index)
public SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder getInvalidConditionBoostSpecsOrBuilder(int index)
The invalid
SearchRequest.BoostSpec.condition_boost_specs
that are not applied during serving.
repeated .google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec invalid_condition_boost_specs = 14;
| Parameter |
| Name |
Description |
index |
int
|
getInvalidConditionBoostSpecsOrBuilderList()
public List<? extends SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder> getInvalidConditionBoostSpecsOrBuilderList()
The invalid
SearchRequest.BoostSpec.condition_boost_specs
that are not applied during serving.
repeated .google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec invalid_condition_boost_specs = 14;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder> |
|
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 = 6;
| 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 = 6;
| Returns |
| Type |
Description |
ByteString |
The bytes for nextPageToken.
|
getParserForType()
public Parser<SearchResponse> getParserForType()
Overrides
getQueryExpansionInfo()
public SearchResponse.QueryExpansionInfo getQueryExpansionInfo()
Query expansion information for the returned results.
.google.cloud.retail.v2.SearchResponse.QueryExpansionInfo query_expansion_info = 7;
getQueryExpansionInfoOrBuilder()
public SearchResponse.QueryExpansionInfoOrBuilder getQueryExpansionInfoOrBuilder()
Query expansion information for the returned results.
.google.cloud.retail.v2.SearchResponse.QueryExpansionInfo query_expansion_info = 7;
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 = 10;
| 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 = 10;
| Returns |
| Type |
Description |
ByteString |
The bytes for redirectUri.
|
getResults(int index)
public SearchResponse.SearchResult getResults(int index)
A list of matched items. The order represents the ranking.
repeated .google.cloud.retail.v2.SearchResponse.SearchResult results = 1;
| Parameter |
| Name |
Description |
index |
int
|
getResultsCount()
public int getResultsCount()
A list of matched items. The order represents the ranking.
repeated .google.cloud.retail.v2.SearchResponse.SearchResult results = 1;
| Returns |
| Type |
Description |
int |
|
getResultsList()
public List<SearchResponse.SearchResult> getResultsList()
A list of matched items. The order represents the ranking.
repeated .google.cloud.retail.v2.SearchResponse.SearchResult results = 1;
getResultsOrBuilder(int index)
public SearchResponse.SearchResultOrBuilder getResultsOrBuilder(int index)
A list of matched items. The order represents the ranking.
repeated .google.cloud.retail.v2.SearchResponse.SearchResult results = 1;
| Parameter |
| Name |
Description |
index |
int
|
getResultsOrBuilderList()
public List<? extends SearchResponse.SearchResultOrBuilder> getResultsOrBuilderList()
A list of matched items. The order represents the ranking.
repeated .google.cloud.retail.v2.SearchResponse.SearchResult results = 1;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.retail.v2.SearchResponse.SearchResultOrBuilder> |
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getTileNavigationResult()
public SearchResponse.TileNavigationResult getTileNavigationResult()
This field specifies all related information for tile navigation that will
be used in client side.
.google.cloud.retail.v2.SearchResponse.TileNavigationResult tile_navigation_result = 19;
getTileNavigationResultOrBuilder()
public SearchResponse.TileNavigationResultOrBuilder getTileNavigationResultOrBuilder()
This field specifies all related information for tile navigation that will
be used in client side.
.google.cloud.retail.v2.SearchResponse.TileNavigationResult tile_navigation_result = 19;
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.
|
hasConversationalSearchResult()
public boolean hasConversationalSearchResult()
This field specifies all related information that is needed on client
side for UI rendering of conversational retail search.
.google.cloud.retail.v2.SearchResponse.ConversationalSearchResult conversational_search_result = 18;
| Returns |
| Type |
Description |
boolean |
Whether the conversationalSearchResult field is set.
|
hasQueryExpansionInfo()
public boolean hasQueryExpansionInfo()
Query expansion information for the returned results.
.google.cloud.retail.v2.SearchResponse.QueryExpansionInfo query_expansion_info = 7;
| Returns |
| Type |
Description |
boolean |
Whether the queryExpansionInfo field is set.
|
hasTileNavigationResult()
public boolean hasTileNavigationResult()
This field specifies all related information for tile navigation that will
be used in client side.
.google.cloud.retail.v2.SearchResponse.TileNavigationResult tile_navigation_result = 19;
| Returns |
| Type |
Description |
boolean |
Whether the tileNavigationResult field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public SearchResponse.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public SearchResponse.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
