Class SearchResponse.Builder (2.0.19) 

public static final class SearchResponse.Builder extends GeneratedMessageV3.Builder<SearchResponse.Builder> implements SearchResponseOrBuilder

Response message for SearchService.Search method.

Protobuf type google.cloud.retail.v2.SearchResponse

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchResponse.Builder

Static 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.

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.v2.SearchResponse.Facet facets = 2;

Parameter
Name Description
values Iterable<? extends com.google.cloud.retail.v2.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.v2.SearchRequest.BoostSpec.ConditionBoostSpec invalid_condition_boost_specs = 14;

Parameter
Name Description
values Iterable<? extends com.google.cloud.retail.v2.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.v2.SearchResponse.SearchResult results = 1;

Parameter
Name Description
values Iterable<? extends com.google.cloud.retail.v2.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 String

The 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 ByteString

The bytes of the appliedControls to add.
Returns
Type Description
SearchResponse.Builder

This builder for chaining.

addFacets(SearchResponse.Facet value)

public SearchResponse.Builder addFacets(SearchResponse.Facet value)

Results of facets requested by user.

repeated .google.cloud.retail.v2.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.v2.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.v2.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.v2.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.v2.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.v2.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.v2.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.v2.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.v2.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.v2.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.v2.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.v2.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
Overrides

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.v2.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.v2.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.v2.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.v2.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.v2.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.v2.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
Overrides

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.

clearCorrectedQuery()

public SearchResponse.Builder clearCorrectedQuery()

If spell correction applies, the corrected query. Otherwise, empty.

string corrected_query = 4;

Returns
Type Description
SearchResponse.Builder

This builder for chaining.

clearFacets()

public SearchResponse.Builder clearFacets()

Results of facets requested by user.

repeated .google.cloud.retail.v2.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
Overrides

clearInvalidConditionBoostSpecs()

public SearchResponse.Builder clearInvalidConditionBoostSpecs()

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
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
Overrides

clearQueryExpansionInfo()

public SearchResponse.Builder clearQueryExpansionInfo()

Query expansion information for the returned results.

.google.cloud.retail.v2.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 will be performed, and only redirect_uri and attribution_token will be 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.v2.SearchResponse.SearchResult results = 1;

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

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.

getCorrectedQuery()

public String getCorrectedQuery()

If spell correction applies, the corrected query. Otherwise, empty.

string corrected_query = 4;

Returns
Type Description
String

The correctedQuery.

getCorrectedQueryBytes()

public ByteString getCorrectedQueryBytes()

If spell correction applies, the corrected query. Otherwise, empty.

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
Overrides

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
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.v2.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.v2.SearchResponse.Facet facets = 2;

Returns
Type Description
List<Builder>

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;

Returns
Type Description
List<Facet>

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
Returns
Type Description
SearchResponse.FacetOrBuilder

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
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.v2.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.v2.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.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;

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.v2.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.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.

getQueryExpansionInfo()

public SearchResponse.QueryExpansionInfo getQueryExpansionInfo()

Query expansion information for the returned results.

.google.cloud.retail.v2.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.v2.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.v2.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 will be performed, and only redirect_uri and attribution_token will be 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 will be performed, and only redirect_uri and attribution_token will be 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
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.v2.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.v2.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.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;

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.v2.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.v2.SearchResponse.SearchResult results = 1;

Returns
Type Description
List<? extends com.google.cloud.retail.v2.SearchResponse.SearchResultOrBuilder>

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Overrides Exceptions
Type Description
IOException

mergeFrom(Message other)

public SearchResponse.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SearchResponse.Builder
Overrides

mergeQueryExpansionInfo(SearchResponse.QueryExpansionInfo value)

public SearchResponse.Builder mergeQueryExpansionInfo(SearchResponse.QueryExpansionInfo value)

Query expansion information for the returned results.

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

Parameter
Name Description
value SearchResponse.QueryExpansionInfo
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
Overrides

removeFacets(int index)

public SearchResponse.Builder removeFacets(int index)

Results of facets requested by user.

repeated .google.cloud.retail.v2.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.v2.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.v2.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 int

The index to set the value at.
value String

The 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 String

The 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 ByteString

The bytes for attributionToken to set.
Returns
Type Description
SearchResponse.Builder

This builder for chaining.

setCorrectedQuery(String value)

public SearchResponse.Builder setCorrectedQuery(String value)

If spell correction applies, the corrected query. Otherwise, empty.

string corrected_query = 4;

Parameter
Name Description
value String

The correctedQuery to set.
Returns
Type Description
SearchResponse.Builder

This builder for chaining.

setCorrectedQueryBytes(ByteString value)

public SearchResponse.Builder setCorrectedQueryBytes(ByteString value)

If spell correction applies, the corrected query. Otherwise, empty.

string corrected_query = 4;

Parameter
Name Description
value ByteString

The bytes for correctedQuery to set.
Returns
Type Description
SearchResponse.Builder

This builder for chaining.

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.v2.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.v2.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
Overrides

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.v2.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.v2.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 String

The 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 ByteString

The bytes for nextPageToken to set.
Returns
Type Description
SearchResponse.Builder

This builder for chaining.

setQueryExpansionInfo(SearchResponse.QueryExpansionInfo value)

public SearchResponse.Builder setQueryExpansionInfo(SearchResponse.QueryExpansionInfo value)

Query expansion information for the returned results.

.google.cloud.retail.v2.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.v2.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 will be performed, and only redirect_uri and attribution_token will be set in the response.

string redirect_uri = 10;

Parameter
Name Description
value String

The 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 will be performed, and only redirect_uri and attribution_token will be set in the response.

string redirect_uri = 10;

Parameter
Name Description
value ByteString

The 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
Overrides

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.v2.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.v2.SearchResponse.SearchResult results = 1;

Parameters
Name Description
index int
builderForValue SearchResponse.SearchResult.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 int

The 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
Overrides