- 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 static final class SearchResponse.Builder extends GeneratedMessageV3.Builder<SearchResponse.Builder> implements SearchResponseOrBuilderResponse message for SearchService.Search method.
Protobuf type google.cloud.retail.v2beta.SearchResponse
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchResponse.BuilderImplements
SearchResponseOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllAppliedControls(Iterable<String> values)
public SearchResponse.Builder addAllAppliedControls(Iterable<String> values)The fully qualified resource name of applied controls.
repeated string applied_controls = 12;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The appliedControls to add. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
This builder for chaining. |
addAllExperimentInfo(Iterable<? extends ExperimentInfo> values)
public SearchResponse.Builder addAllExperimentInfo(Iterable<? extends ExperimentInfo> values)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 |
values |
Iterable<? extends com.google.cloud.retail.v2beta.ExperimentInfo> |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
addAllFacets(Iterable<? extends SearchResponse.Facet> values)
public SearchResponse.Builder addAllFacets(Iterable<? extends SearchResponse.Facet> values)Results of facets requested by user.
repeated .google.cloud.retail.v2beta.SearchResponse.Facet facets = 2;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.retail.v2beta.SearchResponse.Facet> |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
addAllInvalidConditionBoostSpecs(Iterable<? extends SearchRequest.BoostSpec.ConditionBoostSpec> values)
public SearchResponse.Builder addAllInvalidConditionBoostSpecs(Iterable<? extends SearchRequest.BoostSpec.ConditionBoostSpec> values)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 |
values |
Iterable<? extends com.google.cloud.retail.v2beta.SearchRequest.BoostSpec.ConditionBoostSpec> |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
addAllResults(Iterable<? extends SearchResponse.SearchResult> values)
public SearchResponse.Builder addAllResults(Iterable<? extends SearchResponse.SearchResult> values)A list of matched items. The order represents the ranking.
repeated .google.cloud.retail.v2beta.SearchResponse.SearchResult results = 1;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.retail.v2beta.SearchResponse.SearchResult> |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
addAppliedControls(String value)
public SearchResponse.Builder addAppliedControls(String value)The fully qualified resource name of applied controls.
repeated string applied_controls = 12;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe appliedControls to add. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
This builder for chaining. |
addAppliedControlsBytes(ByteString value)
public SearchResponse.Builder addAppliedControlsBytes(ByteString value)The fully qualified resource name of applied controls.
repeated string applied_controls = 12;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the appliedControls to add. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
This builder for chaining. |
addExperimentInfo(ExperimentInfo value)
public SearchResponse.Builder addExperimentInfo(ExperimentInfo value)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 |
value |
ExperimentInfo |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
addExperimentInfo(ExperimentInfo.Builder builderForValue)
public SearchResponse.Builder addExperimentInfo(ExperimentInfo.Builder builderForValue)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 |
builderForValue |
ExperimentInfo.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
addExperimentInfo(int index, ExperimentInfo value)
public SearchResponse.Builder addExperimentInfo(int index, ExperimentInfo value)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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
ExperimentInfo |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
addExperimentInfo(int index, ExperimentInfo.Builder builderForValue)
public SearchResponse.Builder addExperimentInfo(int index, ExperimentInfo.Builder builderForValue)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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
ExperimentInfo.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
addExperimentInfoBuilder()
public ExperimentInfo.Builder addExperimentInfoBuilder()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 |
ExperimentInfo.Builder |
|
addExperimentInfoBuilder(int index)
public ExperimentInfo.Builder addExperimentInfoBuilder(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.Builder |
|
addFacets(SearchResponse.Facet value)
public SearchResponse.Builder addFacets(SearchResponse.Facet value)Results of facets requested by user.
repeated .google.cloud.retail.v2beta.SearchResponse.Facet facets = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
SearchResponse.Facet |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
addFacets(SearchResponse.Facet.Builder builderForValue)
public SearchResponse.Builder addFacets(SearchResponse.Facet.Builder builderForValue)Results of facets requested by user.
repeated .google.cloud.retail.v2beta.SearchResponse.Facet facets = 2;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
SearchResponse.Facet.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
addFacets(int index, SearchResponse.Facet value)
public SearchResponse.Builder addFacets(int index, SearchResponse.Facet value)Results of facets requested by user.
repeated .google.cloud.retail.v2beta.SearchResponse.Facet facets = 2;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
SearchResponse.Facet |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
addFacets(int index, SearchResponse.Facet.Builder builderForValue)
public SearchResponse.Builder addFacets(int index, SearchResponse.Facet.Builder builderForValue)Results of facets requested by user.
repeated .google.cloud.retail.v2beta.SearchResponse.Facet facets = 2;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
SearchResponse.Facet.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
addFacetsBuilder()
public SearchResponse.Facet.Builder addFacetsBuilder()Results of facets requested by user.
repeated .google.cloud.retail.v2beta.SearchResponse.Facet facets = 2;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Facet.Builder |
|
addFacetsBuilder(int index)
public SearchResponse.Facet.Builder addFacetsBuilder(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.Builder |
|
addInvalidConditionBoostSpecs(SearchRequest.BoostSpec.ConditionBoostSpec value)
public SearchResponse.Builder addInvalidConditionBoostSpecs(SearchRequest.BoostSpec.ConditionBoostSpec value)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 |
value |
SearchRequest.BoostSpec.ConditionBoostSpec |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
addInvalidConditionBoostSpecs(SearchRequest.BoostSpec.ConditionBoostSpec.Builder builderForValue)
public SearchResponse.Builder addInvalidConditionBoostSpecs(SearchRequest.BoostSpec.ConditionBoostSpec.Builder builderForValue)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 |
builderForValue |
SearchRequest.BoostSpec.ConditionBoostSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
addInvalidConditionBoostSpecs(int index, SearchRequest.BoostSpec.ConditionBoostSpec value)
public SearchResponse.Builder addInvalidConditionBoostSpecs(int index, SearchRequest.BoostSpec.ConditionBoostSpec value)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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
SearchRequest.BoostSpec.ConditionBoostSpec |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
addInvalidConditionBoostSpecs(int index, SearchRequest.BoostSpec.ConditionBoostSpec.Builder builderForValue)
public SearchResponse.Builder addInvalidConditionBoostSpecs(int index, SearchRequest.BoostSpec.ConditionBoostSpec.Builder builderForValue)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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
SearchRequest.BoostSpec.ConditionBoostSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
addInvalidConditionBoostSpecsBuilder()
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder addInvalidConditionBoostSpecsBuilder()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 |
SearchRequest.BoostSpec.ConditionBoostSpec.Builder |
|
addInvalidConditionBoostSpecsBuilder(int index)
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder addInvalidConditionBoostSpecsBuilder(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.Builder |
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SearchResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
addResults(SearchResponse.SearchResult value)
public SearchResponse.Builder addResults(SearchResponse.SearchResult value)A list of matched items. The order represents the ranking.
repeated .google.cloud.retail.v2beta.SearchResponse.SearchResult results = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
SearchResponse.SearchResult |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
addResults(SearchResponse.SearchResult.Builder builderForValue)
public SearchResponse.Builder addResults(SearchResponse.SearchResult.Builder builderForValue)A list of matched items. The order represents the ranking.
repeated .google.cloud.retail.v2beta.SearchResponse.SearchResult results = 1;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
SearchResponse.SearchResult.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
addResults(int index, SearchResponse.SearchResult value)
public SearchResponse.Builder addResults(int index, SearchResponse.SearchResult value)A list of matched items. The order represents the ranking.
repeated .google.cloud.retail.v2beta.SearchResponse.SearchResult results = 1;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
SearchResponse.SearchResult |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
addResults(int index, SearchResponse.SearchResult.Builder builderForValue)
public SearchResponse.Builder addResults(int index, SearchResponse.SearchResult.Builder builderForValue)A list of matched items. The order represents the ranking.
repeated .google.cloud.retail.v2beta.SearchResponse.SearchResult results = 1;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
SearchResponse.SearchResult.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
addResultsBuilder()
public SearchResponse.SearchResult.Builder addResultsBuilder()A list of matched items. The order represents the ranking.
repeated .google.cloud.retail.v2beta.SearchResponse.SearchResult results = 1;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder |
|
addResultsBuilder(int index)
public SearchResponse.SearchResult.Builder addResultsBuilder(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.Builder |
|
build()
public SearchResponse build()| Returns | |
|---|---|
| Type | Description |
SearchResponse |
|
buildPartial()
public SearchResponse buildPartial()| Returns | |
|---|---|
| Type | Description |
SearchResponse |
|
clear()
public SearchResponse.Builder clear()| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
clearAppliedControls()
public SearchResponse.Builder clearAppliedControls()The fully qualified resource name of applied controls.
repeated string applied_controls = 12;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
This builder for chaining. |
clearAttributionToken()
public SearchResponse.Builder clearAttributionToken()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 |
SearchResponse.Builder |
This builder for chaining. |
clearConversationalSearchResult()
public SearchResponse.Builder clearConversationalSearchResult()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.Builder |
|
clearCorrectedQuery()
public SearchResponse.Builder clearCorrectedQuery()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 |
SearchResponse.Builder |
This builder for chaining. |
clearExperimentInfo()
public SearchResponse.Builder clearExperimentInfo()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 |
SearchResponse.Builder |
|
clearFacets()
public SearchResponse.Builder clearFacets()Results of facets requested by user.
repeated .google.cloud.retail.v2beta.SearchResponse.Facet facets = 2;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public SearchResponse.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
clearInvalidConditionBoostSpecs()
public SearchResponse.Builder clearInvalidConditionBoostSpecs()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 |
SearchResponse.Builder |
|
clearNextPageToken()
public SearchResponse.Builder clearNextPageToken()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 |
SearchResponse.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public SearchResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
clearPinControlMetadata()
public SearchResponse.Builder clearPinControlMetadata()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 |
SearchResponse.Builder |
|
clearQueryExpansionInfo()
public SearchResponse.Builder clearQueryExpansionInfo()Query expansion information for the returned results.
.google.cloud.retail.v2beta.SearchResponse.QueryExpansionInfo query_expansion_info = 7;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
clearRedirectUri()
public SearchResponse.Builder clearRedirectUri()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 |
SearchResponse.Builder |
This builder for chaining. |
clearResults()
public SearchResponse.Builder clearResults()A list of matched items. The order represents the ranking.
repeated .google.cloud.retail.v2beta.SearchResponse.SearchResult results = 1;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
clearTileNavigationResult()
public SearchResponse.Builder clearTileNavigationResult()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.Builder |
|
clearTotalSize()
public SearchResponse.Builder clearTotalSize()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 |
SearchResponse.Builder |
This builder for chaining. |
clone()
public SearchResponse.Builder clone()| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
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 |
intThe 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 |
intThe 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;
| 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.
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.v2beta.SearchResponse.ConversationalSearchResult conversational_search_result = 18;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResult |
The conversationalSearchResult. |
getConversationalSearchResultBuilder()
public SearchResponse.ConversationalSearchResult.Builder getConversationalSearchResultBuilder()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.Builder |
|
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.v2beta.SearchResponse.ConversationalSearchResult conversational_search_result = 18;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.ConversationalSearchResultOrBuilder |
|
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()| Returns | |
|---|---|
| Type | Description |
SearchResponse |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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.v2beta.ExperimentInfo experiment_info = 17;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ExperimentInfo |
|
getExperimentInfoBuilder(int index)
public ExperimentInfo.Builder getExperimentInfoBuilder(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.Builder |
|
getExperimentInfoBuilderList()
public List<ExperimentInfo.Builder> getExperimentInfoBuilderList()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<Builder> |
|
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.v2beta.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.v2beta.ExperimentInfo experiment_info = 17;
| Returns | |
|---|---|
| Type | Description |
List<ExperimentInfo> |
|
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.v2beta.ExperimentInfo experiment_info = 17;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ExperimentInfoOrBuilder |
|
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.v2beta.ExperimentInfo experiment_info = 17;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.retail.v2beta.ExperimentInfoOrBuilder> |
|
getFacets(int index)
public 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 |
|
getFacetsBuilder(int index)
public SearchResponse.Facet.Builder getFacetsBuilder(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.Builder |
|
getFacetsBuilderList()
public List<SearchResponse.Facet.Builder> getFacetsBuilderList()Results of facets requested by user.
repeated .google.cloud.retail.v2beta.SearchResponse.Facet facets = 2;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getFacetsCount()
public int getFacetsCount()Results of facets requested by user.
repeated .google.cloud.retail.v2beta.SearchResponse.Facet facets = 2;
| Returns | |
|---|---|
| Type | Description |
int |
|
getFacetsList()
public 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 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 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 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 |
|
getInvalidConditionBoostSpecsBuilder(int index)
public SearchRequest.BoostSpec.ConditionBoostSpec.Builder getInvalidConditionBoostSpecsBuilder(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.Builder |
|
getInvalidConditionBoostSpecsBuilderList()
public List<SearchRequest.BoostSpec.ConditionBoostSpec.Builder> getInvalidConditionBoostSpecsBuilderList()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<Builder> |
|
getInvalidConditionBoostSpecsCount()
public 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 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 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 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 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. |
getPinControlMetadata()
public 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. |
getPinControlMetadataBuilder()
public PinControlMetadata.Builder getPinControlMetadataBuilder()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.Builder |
|
getPinControlMetadataOrBuilder()
public 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 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. |
getQueryExpansionInfoBuilder()
public SearchResponse.QueryExpansionInfo.Builder getQueryExpansionInfoBuilder()Query expansion information for the returned results.
.google.cloud.retail.v2beta.SearchResponse.QueryExpansionInfo query_expansion_info = 7;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.QueryExpansionInfo.Builder |
|
getQueryExpansionInfoOrBuilder()
public 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 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.v2beta.SearchResponse.SearchResult results = 1;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult |
|
getResultsBuilder(int index)
public SearchResponse.SearchResult.Builder getResultsBuilder(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.Builder |
|
getResultsBuilderList()
public List<SearchResponse.SearchResult.Builder> getResultsBuilderList()A list of matched items. The order represents the ranking.
repeated .google.cloud.retail.v2beta.SearchResponse.SearchResult results = 1;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getResultsCount()
public 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 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 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 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 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. |
getTileNavigationResultBuilder()
public SearchResponse.TileNavigationResult.Builder getTileNavigationResultBuilder()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.Builder |
|
getTileNavigationResultOrBuilder()
public 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 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.v2beta.SearchResponse.ConversationalSearchResult conversational_search_result = 18;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the conversationalSearchResult field is set. |
hasPinControlMetadata()
public 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 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeConversationalSearchResult(SearchResponse.ConversationalSearchResult value)
public SearchResponse.Builder mergeConversationalSearchResult(SearchResponse.ConversationalSearchResult value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
SearchResponse.ConversationalSearchResult |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
mergeFrom(SearchResponse other)
public SearchResponse.Builder mergeFrom(SearchResponse other)| Parameter | |
|---|---|
| Name | Description |
other |
SearchResponse |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SearchResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public SearchResponse.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
mergePinControlMetadata(PinControlMetadata value)
public SearchResponse.Builder mergePinControlMetadata(PinControlMetadata value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
PinControlMetadata |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
mergeQueryExpansionInfo(SearchResponse.QueryExpansionInfo value)
public SearchResponse.Builder mergeQueryExpansionInfo(SearchResponse.QueryExpansionInfo value)Query expansion information for the returned results.
.google.cloud.retail.v2beta.SearchResponse.QueryExpansionInfo query_expansion_info = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
SearchResponse.QueryExpansionInfo |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
mergeTileNavigationResult(SearchResponse.TileNavigationResult value)
public SearchResponse.Builder mergeTileNavigationResult(SearchResponse.TileNavigationResult value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
SearchResponse.TileNavigationResult |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SearchResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
removeExperimentInfo(int index)
public SearchResponse.Builder removeExperimentInfo(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 |
SearchResponse.Builder |
|
removeFacets(int index)
public SearchResponse.Builder removeFacets(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.Builder |
|
removeInvalidConditionBoostSpecs(int index)
public SearchResponse.Builder removeInvalidConditionBoostSpecs(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 |
SearchResponse.Builder |
|
removeResults(int index)
public SearchResponse.Builder removeResults(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.Builder |
|
setAppliedControls(int index, String value)
public SearchResponse.Builder setAppliedControls(int index, String value)The fully qualified resource name of applied controls.
repeated string applied_controls = 12;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe appliedControls to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
This builder for chaining. |
setAttributionToken(String value)
public SearchResponse.Builder setAttributionToken(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe attributionToken to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
This builder for chaining. |
setAttributionTokenBytes(ByteString value)
public SearchResponse.Builder setAttributionTokenBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for attributionToken to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
This builder for chaining. |
setConversationalSearchResult(SearchResponse.ConversationalSearchResult value)
public SearchResponse.Builder setConversationalSearchResult(SearchResponse.ConversationalSearchResult value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
SearchResponse.ConversationalSearchResult |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
setConversationalSearchResult(SearchResponse.ConversationalSearchResult.Builder builderForValue)
public SearchResponse.Builder setConversationalSearchResult(SearchResponse.ConversationalSearchResult.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
SearchResponse.ConversationalSearchResult.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
setCorrectedQuery(String value)
public SearchResponse.Builder setCorrectedQuery(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe correctedQuery to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
This builder for chaining. |
setCorrectedQueryBytes(ByteString value)
public SearchResponse.Builder setCorrectedQueryBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for correctedQuery to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
This builder for chaining. |
setExperimentInfo(int index, ExperimentInfo value)
public SearchResponse.Builder setExperimentInfo(int index, ExperimentInfo value)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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
ExperimentInfo |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
setExperimentInfo(int index, ExperimentInfo.Builder builderForValue)
public SearchResponse.Builder setExperimentInfo(int index, ExperimentInfo.Builder builderForValue)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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
ExperimentInfo.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
setFacets(int index, SearchResponse.Facet value)
public SearchResponse.Builder setFacets(int index, SearchResponse.Facet value)Results of facets requested by user.
repeated .google.cloud.retail.v2beta.SearchResponse.Facet facets = 2;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
SearchResponse.Facet |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
setFacets(int index, SearchResponse.Facet.Builder builderForValue)
public SearchResponse.Builder setFacets(int index, SearchResponse.Facet.Builder builderForValue)Results of facets requested by user.
repeated .google.cloud.retail.v2beta.SearchResponse.Facet facets = 2;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
SearchResponse.Facet.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public SearchResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
setInvalidConditionBoostSpecs(int index, SearchRequest.BoostSpec.ConditionBoostSpec value)
public SearchResponse.Builder setInvalidConditionBoostSpecs(int index, SearchRequest.BoostSpec.ConditionBoostSpec value)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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
SearchRequest.BoostSpec.ConditionBoostSpec |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
setInvalidConditionBoostSpecs(int index, SearchRequest.BoostSpec.ConditionBoostSpec.Builder builderForValue)
public SearchResponse.Builder setInvalidConditionBoostSpecs(int index, SearchRequest.BoostSpec.ConditionBoostSpec.Builder builderForValue)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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
SearchRequest.BoostSpec.ConditionBoostSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
setNextPageToken(String value)
public SearchResponse.Builder setNextPageToken(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe nextPageToken to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
This builder for chaining. |
setNextPageTokenBytes(ByteString value)
public SearchResponse.Builder setNextPageTokenBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for nextPageToken to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
This builder for chaining. |
setPinControlMetadata(PinControlMetadata value)
public SearchResponse.Builder setPinControlMetadata(PinControlMetadata value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
PinControlMetadata |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
setPinControlMetadata(PinControlMetadata.Builder builderForValue)
public SearchResponse.Builder setPinControlMetadata(PinControlMetadata.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
PinControlMetadata.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
setQueryExpansionInfo(SearchResponse.QueryExpansionInfo value)
public SearchResponse.Builder setQueryExpansionInfo(SearchResponse.QueryExpansionInfo value)Query expansion information for the returned results.
.google.cloud.retail.v2beta.SearchResponse.QueryExpansionInfo query_expansion_info = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
SearchResponse.QueryExpansionInfo |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
setQueryExpansionInfo(SearchResponse.QueryExpansionInfo.Builder builderForValue)
public SearchResponse.Builder setQueryExpansionInfo(SearchResponse.QueryExpansionInfo.Builder builderForValue)Query expansion information for the returned results.
.google.cloud.retail.v2beta.SearchResponse.QueryExpansionInfo query_expansion_info = 7;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
SearchResponse.QueryExpansionInfo.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
setRedirectUri(String value)
public SearchResponse.Builder setRedirectUri(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe redirectUri to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
This builder for chaining. |
setRedirectUriBytes(ByteString value)
public SearchResponse.Builder setRedirectUriBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for redirectUri to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SearchResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
setResults(int index, SearchResponse.SearchResult value)
public SearchResponse.Builder setResults(int index, SearchResponse.SearchResult value)A list of matched items. The order represents the ranking.
repeated .google.cloud.retail.v2beta.SearchResponse.SearchResult results = 1;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
SearchResponse.SearchResult |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
setResults(int index, SearchResponse.SearchResult.Builder builderForValue)
public SearchResponse.Builder setResults(int index, SearchResponse.SearchResult.Builder builderForValue)A list of matched items. The order represents the ranking.
repeated .google.cloud.retail.v2beta.SearchResponse.SearchResult results = 1;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
SearchResponse.SearchResult.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
setTileNavigationResult(SearchResponse.TileNavigationResult value)
public SearchResponse.Builder setTileNavigationResult(SearchResponse.TileNavigationResult value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
SearchResponse.TileNavigationResult |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
setTileNavigationResult(SearchResponse.TileNavigationResult.Builder builderForValue)
public SearchResponse.Builder setTileNavigationResult(SearchResponse.TileNavigationResult.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
SearchResponse.TileNavigationResult.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|
setTotalSize(int value)
public SearchResponse.Builder setTotalSize(int value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe totalSize to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final SearchResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.Builder |
|