Class SearchResponse.Builder (0.36.0)

Version 0.36.0

• 0.51.0 (latest)
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

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

Response message for SearchService.Search method.

Protobuf type google.cloud.discoveryengine.v1beta.SearchResponse

Inheritance

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

Implements

SearchResponseOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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)

Controls applied as part of the Control service.

repeated string applied_controls = 10;

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

Parameter
Name	Description
values	Iterable<? extends com.google.cloud.discoveryengine.v1beta.SearchResponse.Facet>

Returns
Type	Description
SearchResponse.Builder

addAllResults(Iterable<? extends SearchResponse.SearchResult> values)

public SearchResponse.Builder addAllResults(Iterable<? extends SearchResponse.SearchResult> values)

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

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult results = 1;

Parameter
Name	Description
values	Iterable<? extends com.google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult>

Returns
Type	Description
SearchResponse.Builder

addAppliedControls(String value)

public SearchResponse.Builder addAppliedControls(String value)

Controls applied as part of the Control service.

repeated string applied_controls = 10;

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)

Controls applied as part of the Control service.

repeated string applied_controls = 10;

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

Parameter
Name	Description
index	int

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addResults(SearchResponse.SearchResult value)

public SearchResponse.Builder addResults(SearchResponse.SearchResult value)

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

repeated .google.cloud.discoveryengine.v1beta.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 documents. The order represents the ranking.

repeated .google.cloud.discoveryengine.v1beta.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 documents. The order represents the ranking.

repeated .google.cloud.discoveryengine.v1beta.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 documents. The order represents the ranking.

repeated .google.cloud.discoveryengine.v1beta.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 documents. The order represents the ranking.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult results = 1;

Returns
Type	Description
SearchResponse.SearchResult.Builder

addResultsBuilder(int index)

public SearchResponse.SearchResult.Builder addResultsBuilder(int index)

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

repeated .google.cloud.discoveryengine.v1beta.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

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAppliedControls()

public SearchResponse.Builder clearAppliedControls()

Controls applied as part of the Control service.

repeated string applied_controls = 10;

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

Returns
Type	Description
SearchResponse.Builder	This builder for chaining.

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

Returns
Type	Description
SearchResponse.Builder	This builder for chaining.

clearFacets()

public SearchResponse.Builder clearFacets()

Results of facets requested by user.

repeated .google.cloud.discoveryengine.v1beta.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

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearGuidedSearchResult()

public SearchResponse.Builder clearGuidedSearchResult()

Guided search result.

.google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult guided_search_result = 8;

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

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

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearQueryExpansionInfo()

public SearchResponse.Builder clearQueryExpansionInfo()

Query expansion information for the returned results.

.google.cloud.discoveryengine.v1beta.SearchResponse.QueryExpansionInfo query_expansion_info = 14;

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

Returns
Type	Description
SearchResponse.Builder	This builder for chaining.

clearResults()

public SearchResponse.Builder clearResults()

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

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult results = 1;

Returns
Type	Description
SearchResponse.Builder

clearSummary()

public SearchResponse.Builder clearSummary()

A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.

.google.cloud.discoveryengine.v1beta.SearchResponse.Summary summary = 9;

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

GeneratedMessageV3.Builder<BuilderType>.clone()

getAppliedControls(int index)

public String getAppliedControls(int index)

Controls applied as part of the Control service.

repeated string applied_controls = 10;

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)

Controls applied as part of the Control service.

repeated string applied_controls = 10;

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()

Controls applied as part of the Control service.

repeated string applied_controls = 10;

Returns
Type	Description
int	The count of appliedControls.

getAppliedControlsList()

public ProtocolStringList getAppliedControlsList()

Controls applied as part of the Control service.

repeated string applied_controls = 10;

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

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

Returns
Type	Description
ByteString	The bytes for attributionToken.

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

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

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

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getFacets(int index)

public SearchResponse.Facet getFacets(int index)

Results of facets requested by user.

repeated .google.cloud.discoveryengine.v1beta.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.discoveryengine.v1beta.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.discoveryengine.v1beta.SearchResponse.Facet facets = 2;

Returns
Type	Description
List<Builder>

getFacetsCount()

public int getFacetsCount()

Results of facets requested by user.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Facet facets = 2;

Returns
Type	Description
int

getFacetsList()

public List<SearchResponse.Facet> getFacetsList()

Results of facets requested by user.

repeated .google.cloud.discoveryengine.v1beta.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.discoveryengine.v1beta.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.discoveryengine.v1beta.SearchResponse.Facet facets = 2;

Returns
Type	Description
List<? extends com.google.cloud.discoveryengine.v1beta.SearchResponse.FacetOrBuilder>

getGuidedSearchResult()

public SearchResponse.GuidedSearchResult getGuidedSearchResult()

Guided search result.

.google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult guided_search_result = 8;

Returns
Type	Description
SearchResponse.GuidedSearchResult	The guidedSearchResult.

getGuidedSearchResultBuilder()

public SearchResponse.GuidedSearchResult.Builder getGuidedSearchResultBuilder()

Guided search result.

.google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult guided_search_result = 8;

Returns
Type	Description
SearchResponse.GuidedSearchResult.Builder

getGuidedSearchResultOrBuilder()

public SearchResponse.GuidedSearchResultOrBuilder getGuidedSearchResultOrBuilder()

Guided search result.

.google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult guided_search_result = 8;

Returns
Type	Description
SearchResponse.GuidedSearchResultOrBuilder

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

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

Returns
Type	Description
ByteString	The bytes for nextPageToken.

getQueryExpansionInfo()

public SearchResponse.QueryExpansionInfo getQueryExpansionInfo()

Query expansion information for the returned results.

.google.cloud.discoveryengine.v1beta.SearchResponse.QueryExpansionInfo query_expansion_info = 14;

Returns
Type	Description
SearchResponse.QueryExpansionInfo	The queryExpansionInfo.

getQueryExpansionInfoBuilder()

public SearchResponse.QueryExpansionInfo.Builder getQueryExpansionInfoBuilder()

Query expansion information for the returned results.

.google.cloud.discoveryengine.v1beta.SearchResponse.QueryExpansionInfo query_expansion_info = 14;

Returns
Type	Description
SearchResponse.QueryExpansionInfo.Builder

getQueryExpansionInfoOrBuilder()

public SearchResponse.QueryExpansionInfoOrBuilder getQueryExpansionInfoOrBuilder()

Query expansion information for the returned results.

.google.cloud.discoveryengine.v1beta.SearchResponse.QueryExpansionInfo query_expansion_info = 14;

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

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

Returns
Type	Description
ByteString	The bytes for redirectUri.

getResults(int index)

public SearchResponse.SearchResult getResults(int index)

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

repeated .google.cloud.discoveryengine.v1beta.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 documents. The order represents the ranking.

repeated .google.cloud.discoveryengine.v1beta.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 documents. The order represents the ranking.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult results = 1;

Returns
Type	Description
List<Builder>

getResultsCount()

public int getResultsCount()

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

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult results = 1;

Returns
Type	Description
int

getResultsList()

public List<SearchResponse.SearchResult> getResultsList()

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

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult results = 1;

Returns
Type	Description
List<SearchResult>

getResultsOrBuilder(int index)

public SearchResponse.SearchResultOrBuilder getResultsOrBuilder(int index)

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

repeated .google.cloud.discoveryengine.v1beta.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 documents. The order represents the ranking.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult results = 1;

Returns
Type	Description
List<? extends com.google.cloud.discoveryengine.v1beta.SearchResponse.SearchResultOrBuilder>

getSummary()

public SearchResponse.Summary getSummary()

A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.

.google.cloud.discoveryengine.v1beta.SearchResponse.Summary summary = 9;

Returns
Type	Description
SearchResponse.Summary	The summary.

getSummaryBuilder()

public SearchResponse.Summary.Builder getSummaryBuilder()

A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.

.google.cloud.discoveryengine.v1beta.SearchResponse.Summary summary = 9;

Returns
Type	Description
SearchResponse.Summary.Builder

getSummaryOrBuilder()

public SearchResponse.SummaryOrBuilder getSummaryOrBuilder()

A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.

.google.cloud.discoveryengine.v1beta.SearchResponse.Summary summary = 9;

Returns
Type	Description
SearchResponse.SummaryOrBuilder

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.

hasGuidedSearchResult()

public boolean hasGuidedSearchResult()

Guided search result.

.google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult guided_search_result = 8;

Returns
Type	Description
boolean	Whether the guidedSearchResult field is set.

hasQueryExpansionInfo()

public boolean hasQueryExpansionInfo()

Query expansion information for the returned results.

.google.cloud.discoveryengine.v1beta.SearchResponse.QueryExpansionInfo query_expansion_info = 14;

Returns
Type	Description
boolean	Whether the queryExpansionInfo field is set.

hasSummary()

public boolean hasSummary()

A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.

.google.cloud.discoveryengine.v1beta.SearchResponse.Summary summary = 9;

Returns
Type	Description
boolean	Whether the summary field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public SearchResponse.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
SearchResponse.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeGuidedSearchResult(SearchResponse.GuidedSearchResult value)

public SearchResponse.Builder mergeGuidedSearchResult(SearchResponse.GuidedSearchResult value)

Guided search result.

.google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult guided_search_result = 8;

Parameter
Name	Description
value	SearchResponse.GuidedSearchResult

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.discoveryengine.v1beta.SearchResponse.QueryExpansionInfo query_expansion_info = 14;

Parameter
Name	Description
value	SearchResponse.QueryExpansionInfo

Returns
Type	Description
SearchResponse.Builder

mergeSummary(SearchResponse.Summary value)

public SearchResponse.Builder mergeSummary(SearchResponse.Summary value)

A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.

.google.cloud.discoveryengine.v1beta.SearchResponse.Summary summary = 9;

Parameter
Name	Description
value	SearchResponse.Summary

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

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeFacets(int index)

public SearchResponse.Builder removeFacets(int index)

Results of facets requested by user.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Facet facets = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
SearchResponse.Builder

removeResults(int index)

public SearchResponse.Builder removeResults(int index)

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

repeated .google.cloud.discoveryengine.v1beta.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)

Controls applied as part of the Control service.

repeated string applied_controls = 10;

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

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

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)

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

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)

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

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.discoveryengine.v1beta.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.discoveryengine.v1beta.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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setGuidedSearchResult(SearchResponse.GuidedSearchResult value)

public SearchResponse.Builder setGuidedSearchResult(SearchResponse.GuidedSearchResult value)

Guided search result.

.google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult guided_search_result = 8;

Parameter
Name	Description
value	SearchResponse.GuidedSearchResult

Returns
Type	Description
SearchResponse.Builder

setGuidedSearchResult(SearchResponse.GuidedSearchResult.Builder builderForValue)

public SearchResponse.Builder setGuidedSearchResult(SearchResponse.GuidedSearchResult.Builder builderForValue)

Guided search result.

.google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult guided_search_result = 8;

Parameter
Name	Description
builderForValue	SearchResponse.GuidedSearchResult.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 = 5;

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

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.discoveryengine.v1beta.SearchResponse.QueryExpansionInfo query_expansion_info = 14;

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.discoveryengine.v1beta.SearchResponse.QueryExpansionInfo query_expansion_info = 14;

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

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 is performed, and only redirect_uri and attribution_token are set in the response.

string redirect_uri = 12;

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setResults(int index, SearchResponse.SearchResult value)

public SearchResponse.Builder setResults(int index, SearchResponse.SearchResult value)

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

repeated .google.cloud.discoveryengine.v1beta.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 documents. The order represents the ranking.

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult results = 1;

Parameters
Name	Description
index	int
builderForValue	SearchResponse.SearchResult.Builder

Returns
Type	Description
SearchResponse.Builder

setSummary(SearchResponse.Summary value)

public SearchResponse.Builder setSummary(SearchResponse.Summary value)

A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.

.google.cloud.discoveryengine.v1beta.SearchResponse.Summary summary = 9;

Parameter
Name	Description
value	SearchResponse.Summary

Returns
Type	Description
SearchResponse.Builder

setSummary(SearchResponse.Summary.Builder builderForValue)

public SearchResponse.Builder setSummary(SearchResponse.Summary.Builder builderForValue)

A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.

.google.cloud.discoveryengine.v1beta.SearchResponse.Summary summary = 9;

Parameter
Name	Description
builderForValue	SearchResponse.Summary.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

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)