Class SearchResponse.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderT>
-
- com.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Builder>
-
- com.google.cloud.discoveryengine.v1beta.SearchResponse.Builder
-
- All Implemented Interfaces:
SearchResponseOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
- SearchResponse
public static final class SearchResponse.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Builder> implements SearchResponseOrBuilder
Response message for [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] method.
Protobuf typegoogle.cloud.discoveryengine.v1beta.SearchResponse
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description SearchResponse.BuilderaddAllAppliedControls(Iterable<String> values)Controls applied as part of the Control service.SearchResponse.BuilderaddAllFacets(Iterable<? extends SearchResponse.Facet> values)Results of facets requested by user.SearchResponse.BuilderaddAllResults(Iterable<? extends SearchResponse.SearchResult> values)A list of matched documents.SearchResponse.BuilderaddAppliedControls(String value)Controls applied as part of the Control service.SearchResponse.BuilderaddAppliedControlsBytes(com.google.protobuf.ByteString value)Controls applied as part of the Control service.SearchResponse.BuilderaddFacets(int index, SearchResponse.Facet value)Results of facets requested by user.SearchResponse.BuilderaddFacets(int index, SearchResponse.Facet.Builder builderForValue)Results of facets requested by user.SearchResponse.BuilderaddFacets(SearchResponse.Facet value)Results of facets requested by user.SearchResponse.BuilderaddFacets(SearchResponse.Facet.Builder builderForValue)Results of facets requested by user.SearchResponse.Facet.BuilderaddFacetsBuilder()Results of facets requested by user.SearchResponse.Facet.BuilderaddFacetsBuilder(int index)Results of facets requested by user.SearchResponse.BuilderaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)SearchResponse.BuilderaddResults(int index, SearchResponse.SearchResult value)A list of matched documents.SearchResponse.BuilderaddResults(int index, SearchResponse.SearchResult.Builder builderForValue)A list of matched documents.SearchResponse.BuilderaddResults(SearchResponse.SearchResult value)A list of matched documents.SearchResponse.BuilderaddResults(SearchResponse.SearchResult.Builder builderForValue)A list of matched documents.SearchResponse.SearchResult.BuilderaddResultsBuilder()A list of matched documents.SearchResponse.SearchResult.BuilderaddResultsBuilder(int index)A list of matched documents.SearchResponsebuild()SearchResponsebuildPartial()SearchResponse.Builderclear()SearchResponse.BuilderclearAppliedControls()Controls applied as part of the Control service.SearchResponse.BuilderclearAttributionToken()A unique search token.SearchResponse.BuilderclearCorrectedQuery()Contains the spell corrected query, if found.SearchResponse.BuilderclearFacets()Results of facets requested by user.SearchResponse.BuilderclearField(com.google.protobuf.Descriptors.FieldDescriptor field)SearchResponse.BuilderclearGuidedSearchResult()Guided search result.SearchResponse.BuilderclearNextPageToken()A token that can be sent as [SearchRequest.page_token][google.cloud.discoveryengine.v1beta.SearchRequest.page_token] to retrieve the next page.SearchResponse.BuilderclearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)SearchResponse.BuilderclearQueryExpansionInfo()Query expansion information for the returned results.SearchResponse.BuilderclearRedirectUri()The URI of a customer-defined redirect page.SearchResponse.BuilderclearResults()A list of matched documents.SearchResponse.BuilderclearSummary()A summary as part of the search results.SearchResponse.BuilderclearTotalSize()The estimated total count of matched items irrespective of pagination.SearchResponse.Builderclone()StringgetAppliedControls(int index)Controls applied as part of the Control service.com.google.protobuf.ByteStringgetAppliedControlsBytes(int index)Controls applied as part of the Control service.intgetAppliedControlsCount()Controls applied as part of the Control service.com.google.protobuf.ProtocolStringListgetAppliedControlsList()Controls applied as part of the Control service.StringgetAttributionToken()A unique search token.com.google.protobuf.ByteStringgetAttributionTokenBytes()A unique search token.StringgetCorrectedQuery()Contains the spell corrected query, if found.com.google.protobuf.ByteStringgetCorrectedQueryBytes()Contains the spell corrected query, if found.SearchResponsegetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()com.google.protobuf.Descriptors.DescriptorgetDescriptorForType()SearchResponse.FacetgetFacets(int index)Results of facets requested by user.SearchResponse.Facet.BuildergetFacetsBuilder(int index)Results of facets requested by user.List<SearchResponse.Facet.Builder>getFacetsBuilderList()Results of facets requested by user.intgetFacetsCount()Results of facets requested by user.List<SearchResponse.Facet>getFacetsList()Results of facets requested by user.SearchResponse.FacetOrBuildergetFacetsOrBuilder(int index)Results of facets requested by user.List<? extends SearchResponse.FacetOrBuilder>getFacetsOrBuilderList()Results of facets requested by user.SearchResponse.GuidedSearchResultgetGuidedSearchResult()Guided search result.SearchResponse.GuidedSearchResult.BuildergetGuidedSearchResultBuilder()Guided search result.SearchResponse.GuidedSearchResultOrBuildergetGuidedSearchResultOrBuilder()Guided search result.StringgetNextPageToken()A token that can be sent as [SearchRequest.page_token][google.cloud.discoveryengine.v1beta.SearchRequest.page_token] to retrieve the next page.com.google.protobuf.ByteStringgetNextPageTokenBytes()A token that can be sent as [SearchRequest.page_token][google.cloud.discoveryengine.v1beta.SearchRequest.page_token] to retrieve the next page.SearchResponse.QueryExpansionInfogetQueryExpansionInfo()Query expansion information for the returned results.SearchResponse.QueryExpansionInfo.BuildergetQueryExpansionInfoBuilder()Query expansion information for the returned results.SearchResponse.QueryExpansionInfoOrBuildergetQueryExpansionInfoOrBuilder()Query expansion information for the returned results.StringgetRedirectUri()The URI of a customer-defined redirect page.com.google.protobuf.ByteStringgetRedirectUriBytes()The URI of a customer-defined redirect page.SearchResponse.SearchResultgetResults(int index)A list of matched documents.SearchResponse.SearchResult.BuildergetResultsBuilder(int index)A list of matched documents.List<SearchResponse.SearchResult.Builder>getResultsBuilderList()A list of matched documents.intgetResultsCount()A list of matched documents.List<SearchResponse.SearchResult>getResultsList()A list of matched documents.SearchResponse.SearchResultOrBuildergetResultsOrBuilder(int index)A list of matched documents.List<? extends SearchResponse.SearchResultOrBuilder>getResultsOrBuilderList()A list of matched documents.SearchResponse.SummarygetSummary()A summary as part of the search results.SearchResponse.Summary.BuildergetSummaryBuilder()A summary as part of the search results.SearchResponse.SummaryOrBuildergetSummaryOrBuilder()A summary as part of the search results.intgetTotalSize()The estimated total count of matched items irrespective of pagination.booleanhasGuidedSearchResult()Guided search result.booleanhasQueryExpansionInfo()Query expansion information for the returned results.booleanhasSummary()A summary as part of the search results.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()booleanisInitialized()SearchResponse.BuildermergeFrom(SearchResponse other)SearchResponse.BuildermergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)SearchResponse.BuildermergeFrom(com.google.protobuf.Message other)SearchResponse.BuildermergeGuidedSearchResult(SearchResponse.GuidedSearchResult value)Guided search result.SearchResponse.BuildermergeQueryExpansionInfo(SearchResponse.QueryExpansionInfo value)Query expansion information for the returned results.SearchResponse.BuildermergeSummary(SearchResponse.Summary value)A summary as part of the search results.SearchResponse.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)SearchResponse.BuilderremoveFacets(int index)Results of facets requested by user.SearchResponse.BuilderremoveResults(int index)A list of matched documents.SearchResponse.BuildersetAppliedControls(int index, String value)Controls applied as part of the Control service.SearchResponse.BuildersetAttributionToken(String value)A unique search token.SearchResponse.BuildersetAttributionTokenBytes(com.google.protobuf.ByteString value)A unique search token.SearchResponse.BuildersetCorrectedQuery(String value)Contains the spell corrected query, if found.SearchResponse.BuildersetCorrectedQueryBytes(com.google.protobuf.ByteString value)Contains the spell corrected query, if found.SearchResponse.BuildersetFacets(int index, SearchResponse.Facet value)Results of facets requested by user.SearchResponse.BuildersetFacets(int index, SearchResponse.Facet.Builder builderForValue)Results of facets requested by user.SearchResponse.BuildersetField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)SearchResponse.BuildersetGuidedSearchResult(SearchResponse.GuidedSearchResult value)Guided search result.SearchResponse.BuildersetGuidedSearchResult(SearchResponse.GuidedSearchResult.Builder builderForValue)Guided search result.SearchResponse.BuildersetNextPageToken(String value)A token that can be sent as [SearchRequest.page_token][google.cloud.discoveryengine.v1beta.SearchRequest.page_token] to retrieve the next page.SearchResponse.BuildersetNextPageTokenBytes(com.google.protobuf.ByteString value)A token that can be sent as [SearchRequest.page_token][google.cloud.discoveryengine.v1beta.SearchRequest.page_token] to retrieve the next page.SearchResponse.BuildersetQueryExpansionInfo(SearchResponse.QueryExpansionInfo value)Query expansion information for the returned results.SearchResponse.BuildersetQueryExpansionInfo(SearchResponse.QueryExpansionInfo.Builder builderForValue)Query expansion information for the returned results.SearchResponse.BuildersetRedirectUri(String value)The URI of a customer-defined redirect page.SearchResponse.BuildersetRedirectUriBytes(com.google.protobuf.ByteString value)The URI of a customer-defined redirect page.SearchResponse.BuildersetRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)SearchResponse.BuildersetResults(int index, SearchResponse.SearchResult value)A list of matched documents.SearchResponse.BuildersetResults(int index, SearchResponse.SearchResult.Builder builderForValue)A list of matched documents.SearchResponse.BuildersetSummary(SearchResponse.Summary value)A summary as part of the search results.SearchResponse.BuildersetSummary(SearchResponse.Summary.Builder builderForValue)A summary as part of the search results.SearchResponse.BuildersetTotalSize(int value)The estimated total count of matched items irrespective of pagination.SearchResponse.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)-
Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Builder>
-
clear
public SearchResponse.Builder clear()
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Builder>
-
getDefaultInstanceForType
public SearchResponse getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
public SearchResponse build()
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public SearchResponse buildPartial()
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
public SearchResponse.Builder clone()
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Builder>
-
setField
public SearchResponse.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Builder>
-
clearField
public SearchResponse.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Builder>
-
clearOneof
public SearchResponse.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Builder>
-
setRepeatedField
public SearchResponse.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
- Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Builder>
-
addRepeatedField
public SearchResponse.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Builder>
-
mergeFrom
public SearchResponse.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<SearchResponse.Builder>
-
mergeFrom
public SearchResponse.Builder mergeFrom(SearchResponse other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Builder>
-
mergeFrom
public SearchResponse.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<SearchResponse.Builder>- Throws:
IOException
-
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;- Specified by:
getResultsListin interfaceSearchResponseOrBuilder
-
getResultsCount
public int getResultsCount()
A list of matched documents. The order represents the ranking.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult results = 1;- Specified by:
getResultsCountin interfaceSearchResponseOrBuilder
-
getResults
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;- Specified by:
getResultsin interfaceSearchResponseOrBuilder
-
setResults
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;
-
setResults
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;
-
addResults
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;
-
addResults
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;
-
addResults
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;
-
addResults
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;
-
addAllResults
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;
-
clearResults
public SearchResponse.Builder clearResults()
A list of matched documents. The order represents the ranking.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult results = 1;
-
removeResults
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;
-
getResultsBuilder
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;
-
getResultsOrBuilder
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;- Specified by:
getResultsOrBuilderin interfaceSearchResponseOrBuilder
-
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;- Specified by:
getResultsOrBuilderListin interfaceSearchResponseOrBuilder
-
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;
-
addResultsBuilder
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;
-
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;
-
getFacetsList
public List<SearchResponse.Facet> getFacetsList()
Results of facets requested by user.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Facet facets = 2;- Specified by:
getFacetsListin interfaceSearchResponseOrBuilder
-
getFacetsCount
public int getFacetsCount()
Results of facets requested by user.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Facet facets = 2;- Specified by:
getFacetsCountin interfaceSearchResponseOrBuilder
-
getFacets
public SearchResponse.Facet getFacets(int index)
Results of facets requested by user.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Facet facets = 2;- Specified by:
getFacetsin interfaceSearchResponseOrBuilder
-
setFacets
public SearchResponse.Builder setFacets(int index, SearchResponse.Facet value)
Results of facets requested by user.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Facet facets = 2;
-
setFacets
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;
-
addFacets
public SearchResponse.Builder addFacets(SearchResponse.Facet value)
Results of facets requested by user.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Facet facets = 2;
-
addFacets
public SearchResponse.Builder addFacets(int index, SearchResponse.Facet value)
Results of facets requested by user.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Facet facets = 2;
-
addFacets
public SearchResponse.Builder addFacets(SearchResponse.Facet.Builder builderForValue)
Results of facets requested by user.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Facet facets = 2;
-
addFacets
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;
-
addAllFacets
public SearchResponse.Builder addAllFacets(Iterable<? extends SearchResponse.Facet> values)
Results of facets requested by user.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Facet facets = 2;
-
clearFacets
public SearchResponse.Builder clearFacets()
Results of facets requested by user.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Facet facets = 2;
-
removeFacets
public SearchResponse.Builder removeFacets(int index)
Results of facets requested by user.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Facet facets = 2;
-
getFacetsBuilder
public SearchResponse.Facet.Builder getFacetsBuilder(int index)
Results of facets requested by user.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Facet facets = 2;
-
getFacetsOrBuilder
public SearchResponse.FacetOrBuilder getFacetsOrBuilder(int index)
Results of facets requested by user.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Facet facets = 2;- Specified by:
getFacetsOrBuilderin interfaceSearchResponseOrBuilder
-
getFacetsOrBuilderList
public List<? extends SearchResponse.FacetOrBuilder> getFacetsOrBuilderList()
Results of facets requested by user.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Facet facets = 2;- Specified by:
getFacetsOrBuilderListin interfaceSearchResponseOrBuilder
-
addFacetsBuilder
public SearchResponse.Facet.Builder addFacetsBuilder()
Results of facets requested by user.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Facet facets = 2;
-
addFacetsBuilder
public SearchResponse.Facet.Builder addFacetsBuilder(int index)
Results of facets requested by user.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Facet facets = 2;
-
getFacetsBuilderList
public List<SearchResponse.Facet.Builder> getFacetsBuilderList()
Results of facets requested by user.
repeated .google.cloud.discoveryengine.v1beta.SearchResponse.Facet facets = 2;
-
hasGuidedSearchResult
public boolean hasGuidedSearchResult()
Guided search result.
.google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult guided_search_result = 8;- Specified by:
hasGuidedSearchResultin interfaceSearchResponseOrBuilder- Returns:
- Whether the guidedSearchResult field is set.
-
getGuidedSearchResult
public SearchResponse.GuidedSearchResult getGuidedSearchResult()
Guided search result.
.google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult guided_search_result = 8;- Specified by:
getGuidedSearchResultin interfaceSearchResponseOrBuilder- Returns:
- The guidedSearchResult.
-
setGuidedSearchResult
public SearchResponse.Builder setGuidedSearchResult(SearchResponse.GuidedSearchResult value)
Guided search result.
.google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult guided_search_result = 8;
-
setGuidedSearchResult
public SearchResponse.Builder setGuidedSearchResult(SearchResponse.GuidedSearchResult.Builder builderForValue)
Guided search result.
.google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult guided_search_result = 8;
-
mergeGuidedSearchResult
public SearchResponse.Builder mergeGuidedSearchResult(SearchResponse.GuidedSearchResult value)
Guided search result.
.google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult guided_search_result = 8;
-
clearGuidedSearchResult
public SearchResponse.Builder clearGuidedSearchResult()
Guided search result.
.google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult guided_search_result = 8;
-
getGuidedSearchResultBuilder
public SearchResponse.GuidedSearchResult.Builder getGuidedSearchResultBuilder()
Guided search result.
.google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult guided_search_result = 8;
-
getGuidedSearchResultOrBuilder
public SearchResponse.GuidedSearchResultOrBuilder getGuidedSearchResultOrBuilder()
Guided search result.
.google.cloud.discoveryengine.v1beta.SearchResponse.GuidedSearchResult guided_search_result = 8;- Specified by:
getGuidedSearchResultOrBuilderin interfaceSearchResponseOrBuilder
-
getTotalSize
public int getTotalSize()
The estimated total count of matched items irrespective of pagination. The count of [results][google.cloud.discoveryengine.v1beta.SearchResponse.results] returned by pagination may be less than the [total_size][google.cloud.discoveryengine.v1beta.SearchResponse.total_size] that matches.
int32 total_size = 3;- Specified by:
getTotalSizein interfaceSearchResponseOrBuilder- Returns:
- The totalSize.
-
setTotalSize
public SearchResponse.Builder setTotalSize(int value)
The estimated total count of matched items irrespective of pagination. The count of [results][google.cloud.discoveryengine.v1beta.SearchResponse.results] returned by pagination may be less than the [total_size][google.cloud.discoveryengine.v1beta.SearchResponse.total_size] that matches.
int32 total_size = 3;- Parameters:
value- The totalSize to set.- Returns:
- This builder for chaining.
-
clearTotalSize
public SearchResponse.Builder clearTotalSize()
The estimated total count of matched items irrespective of pagination. The count of [results][google.cloud.discoveryengine.v1beta.SearchResponse.results] returned by pagination may be less than the [total_size][google.cloud.discoveryengine.v1beta.SearchResponse.total_size] that matches.
int32 total_size = 3;- Returns:
- This builder for chaining.
-
getAttributionToken
public String getAttributionToken()
A unique search token. This should be included in the [UserEvent][google.cloud.discoveryengine.v1beta.UserEvent] logs resulting from this search, which enables accurate attribution of search model performance.
string attribution_token = 4;- Specified by:
getAttributionTokenin interfaceSearchResponseOrBuilder- Returns:
- The attributionToken.
-
getAttributionTokenBytes
public com.google.protobuf.ByteString getAttributionTokenBytes()
A unique search token. This should be included in the [UserEvent][google.cloud.discoveryengine.v1beta.UserEvent] logs resulting from this search, which enables accurate attribution of search model performance.
string attribution_token = 4;- Specified by:
getAttributionTokenBytesin interfaceSearchResponseOrBuilder- Returns:
- The bytes for attributionToken.
-
setAttributionToken
public SearchResponse.Builder setAttributionToken(String value)
A unique search token. This should be included in the [UserEvent][google.cloud.discoveryengine.v1beta.UserEvent] logs resulting from this search, which enables accurate attribution of search model performance.
string attribution_token = 4;- Parameters:
value- The attributionToken to set.- Returns:
- This builder for chaining.
-
clearAttributionToken
public SearchResponse.Builder clearAttributionToken()
A unique search token. This should be included in the [UserEvent][google.cloud.discoveryengine.v1beta.UserEvent] logs resulting from this search, which enables accurate attribution of search model performance.
string attribution_token = 4;- Returns:
- This builder for chaining.
-
setAttributionTokenBytes
public SearchResponse.Builder setAttributionTokenBytes(com.google.protobuf.ByteString value)
A unique search token. This should be included in the [UserEvent][google.cloud.discoveryengine.v1beta.UserEvent] logs resulting from this search, which enables accurate attribution of search model performance.
string attribution_token = 4;- Parameters:
value- The bytes for attributionToken to set.- Returns:
- This builder for chaining.
-
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][google.cloud.discoveryengine.v1beta.SearchResponse.redirect_uri] and [attribution_token][google.cloud.discoveryengine.v1beta.SearchResponse.attribution_token] are set in the response.
string redirect_uri = 12;- Specified by:
getRedirectUriin interfaceSearchResponseOrBuilder- Returns:
- The redirectUri.
-
getRedirectUriBytes
public com.google.protobuf.ByteString getRedirectUriBytes()
The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only [redirect_uri][google.cloud.discoveryengine.v1beta.SearchResponse.redirect_uri] and [attribution_token][google.cloud.discoveryengine.v1beta.SearchResponse.attribution_token] are set in the response.
string redirect_uri = 12;- Specified by:
getRedirectUriBytesin interfaceSearchResponseOrBuilder- Returns:
- The bytes for redirectUri.
-
setRedirectUri
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][google.cloud.discoveryengine.v1beta.SearchResponse.redirect_uri] and [attribution_token][google.cloud.discoveryengine.v1beta.SearchResponse.attribution_token] are set in the response.
string redirect_uri = 12;- Parameters:
value- The redirectUri to set.- Returns:
- This builder for chaining.
-
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][google.cloud.discoveryengine.v1beta.SearchResponse.redirect_uri] and [attribution_token][google.cloud.discoveryengine.v1beta.SearchResponse.attribution_token] are set in the response.
string redirect_uri = 12;- Returns:
- This builder for chaining.
-
setRedirectUriBytes
public SearchResponse.Builder setRedirectUriBytes(com.google.protobuf.ByteString value)
The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only [redirect_uri][google.cloud.discoveryengine.v1beta.SearchResponse.redirect_uri] and [attribution_token][google.cloud.discoveryengine.v1beta.SearchResponse.attribution_token] are set in the response.
string redirect_uri = 12;- Parameters:
value- The bytes for redirectUri to set.- Returns:
- This builder for chaining.
-
getNextPageToken
public String getNextPageToken()
A token that can be sent as [SearchRequest.page_token][google.cloud.discoveryengine.v1beta.SearchRequest.page_token] to retrieve the next page. If this field is omitted, there are no subsequent pages.
string next_page_token = 5;- Specified by:
getNextPageTokenin interfaceSearchResponseOrBuilder- Returns:
- The nextPageToken.
-
getNextPageTokenBytes
public com.google.protobuf.ByteString getNextPageTokenBytes()
A token that can be sent as [SearchRequest.page_token][google.cloud.discoveryengine.v1beta.SearchRequest.page_token] to retrieve the next page. If this field is omitted, there are no subsequent pages.
string next_page_token = 5;- Specified by:
getNextPageTokenBytesin interfaceSearchResponseOrBuilder- Returns:
- The bytes for nextPageToken.
-
setNextPageToken
public SearchResponse.Builder setNextPageToken(String value)
A token that can be sent as [SearchRequest.page_token][google.cloud.discoveryengine.v1beta.SearchRequest.page_token] to retrieve the next page. If this field is omitted, there are no subsequent pages.
string next_page_token = 5;- Parameters:
value- The nextPageToken to set.- Returns:
- This builder for chaining.
-
clearNextPageToken
public SearchResponse.Builder clearNextPageToken()
A token that can be sent as [SearchRequest.page_token][google.cloud.discoveryengine.v1beta.SearchRequest.page_token] to retrieve the next page. If this field is omitted, there are no subsequent pages.
string next_page_token = 5;- Returns:
- This builder for chaining.
-
setNextPageTokenBytes
public SearchResponse.Builder setNextPageTokenBytes(com.google.protobuf.ByteString value)
A token that can be sent as [SearchRequest.page_token][google.cloud.discoveryengine.v1beta.SearchRequest.page_token] to retrieve the next page. If this field is omitted, there are no subsequent pages.
string next_page_token = 5;- Parameters:
value- The bytes for nextPageToken to set.- Returns:
- This builder for chaining.
-
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;- Specified by:
getCorrectedQueryin interfaceSearchResponseOrBuilder- Returns:
- The correctedQuery.
-
getCorrectedQueryBytes
public com.google.protobuf.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;- Specified by:
getCorrectedQueryBytesin interfaceSearchResponseOrBuilder- Returns:
- The bytes for correctedQuery.
-
setCorrectedQuery
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;- Parameters:
value- The correctedQuery to set.- Returns:
- 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:
- This builder for chaining.
-
setCorrectedQueryBytes
public SearchResponse.Builder setCorrectedQueryBytes(com.google.protobuf.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;- Parameters:
value- The bytes for correctedQuery to set.- Returns:
- This builder for chaining.
-
hasSummary
public boolean hasSummary()
A summary as part of the search results. This field is only returned if [SearchRequest.ContentSearchSpec.summary_spec][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.summary_spec] is set.
.google.cloud.discoveryengine.v1beta.SearchResponse.Summary summary = 9;- Specified by:
hasSummaryin interfaceSearchResponseOrBuilder- Returns:
- Whether the summary field is set.
-
getSummary
public SearchResponse.Summary getSummary()
A summary as part of the search results. This field is only returned if [SearchRequest.ContentSearchSpec.summary_spec][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.summary_spec] is set.
.google.cloud.discoveryengine.v1beta.SearchResponse.Summary summary = 9;- Specified by:
getSummaryin interfaceSearchResponseOrBuilder- Returns:
- The summary.
-
setSummary
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][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.summary_spec] is set.
.google.cloud.discoveryengine.v1beta.SearchResponse.Summary summary = 9;
-
setSummary
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][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.summary_spec] is set.
.google.cloud.discoveryengine.v1beta.SearchResponse.Summary summary = 9;
-
mergeSummary
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][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.summary_spec] is set.
.google.cloud.discoveryengine.v1beta.SearchResponse.Summary summary = 9;
-
clearSummary
public SearchResponse.Builder clearSummary()
A summary as part of the search results. This field is only returned if [SearchRequest.ContentSearchSpec.summary_spec][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.summary_spec] is set.
.google.cloud.discoveryengine.v1beta.SearchResponse.Summary summary = 9;
-
getSummaryBuilder
public SearchResponse.Summary.Builder getSummaryBuilder()
A summary as part of the search results. This field is only returned if [SearchRequest.ContentSearchSpec.summary_spec][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.summary_spec] is set.
.google.cloud.discoveryengine.v1beta.SearchResponse.Summary summary = 9;
-
getSummaryOrBuilder
public SearchResponse.SummaryOrBuilder getSummaryOrBuilder()
A summary as part of the search results. This field is only returned if [SearchRequest.ContentSearchSpec.summary_spec][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.summary_spec] is set.
.google.cloud.discoveryengine.v1beta.SearchResponse.Summary summary = 9;- Specified by:
getSummaryOrBuilderin interfaceSearchResponseOrBuilder
-
getAppliedControlsList
public com.google.protobuf.ProtocolStringList getAppliedControlsList()
Controls applied as part of the Control service.
repeated string applied_controls = 10;- Specified by:
getAppliedControlsListin interfaceSearchResponseOrBuilder- Returns:
- A list containing the appliedControls.
-
getAppliedControlsCount
public int getAppliedControlsCount()
Controls applied as part of the Control service.
repeated string applied_controls = 10;- Specified by:
getAppliedControlsCountin interfaceSearchResponseOrBuilder- Returns:
- The count of appliedControls.
-
getAppliedControls
public String getAppliedControls(int index)
Controls applied as part of the Control service.
repeated string applied_controls = 10;- Specified by:
getAppliedControlsin interfaceSearchResponseOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The appliedControls at the given index.
-
getAppliedControlsBytes
public com.google.protobuf.ByteString getAppliedControlsBytes(int index)
Controls applied as part of the Control service.
repeated string applied_controls = 10;- Specified by:
getAppliedControlsBytesin interfaceSearchResponseOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the appliedControls at the given index.
-
setAppliedControls
public SearchResponse.Builder setAppliedControls(int index, String value)
Controls applied as part of the Control service.
repeated string applied_controls = 10;- Parameters:
index- The index to set the value at.value- The appliedControls to set.- Returns:
- This builder for chaining.
-
addAppliedControls
public SearchResponse.Builder addAppliedControls(String value)
Controls applied as part of the Control service.
repeated string applied_controls = 10;- Parameters:
value- The appliedControls to add.- Returns:
- This builder for chaining.
-
addAllAppliedControls
public SearchResponse.Builder addAllAppliedControls(Iterable<String> values)
Controls applied as part of the Control service.
repeated string applied_controls = 10;- Parameters:
values- The appliedControls to add.- Returns:
- This builder for chaining.
-
clearAppliedControls
public SearchResponse.Builder clearAppliedControls()
Controls applied as part of the Control service.
repeated string applied_controls = 10;- Returns:
- This builder for chaining.
-
addAppliedControlsBytes
public SearchResponse.Builder addAppliedControlsBytes(com.google.protobuf.ByteString value)
Controls applied as part of the Control service.
repeated string applied_controls = 10;- Parameters:
value- The bytes of the appliedControls to add.- Returns:
- This builder for chaining.
-
hasQueryExpansionInfo
public boolean hasQueryExpansionInfo()
Query expansion information for the returned results.
.google.cloud.discoveryengine.v1beta.SearchResponse.QueryExpansionInfo query_expansion_info = 14;- Specified by:
hasQueryExpansionInfoin interfaceSearchResponseOrBuilder- Returns:
- Whether the queryExpansionInfo field is set.
-
getQueryExpansionInfo
public SearchResponse.QueryExpansionInfo getQueryExpansionInfo()
Query expansion information for the returned results.
.google.cloud.discoveryengine.v1beta.SearchResponse.QueryExpansionInfo query_expansion_info = 14;- Specified by:
getQueryExpansionInfoin interfaceSearchResponseOrBuilder- Returns:
- The queryExpansionInfo.
-
setQueryExpansionInfo
public SearchResponse.Builder setQueryExpansionInfo(SearchResponse.QueryExpansionInfo value)
Query expansion information for the returned results.
.google.cloud.discoveryengine.v1beta.SearchResponse.QueryExpansionInfo query_expansion_info = 14;
-
setQueryExpansionInfo
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;
-
mergeQueryExpansionInfo
public SearchResponse.Builder mergeQueryExpansionInfo(SearchResponse.QueryExpansionInfo value)
Query expansion information for the returned results.
.google.cloud.discoveryengine.v1beta.SearchResponse.QueryExpansionInfo query_expansion_info = 14;
-
clearQueryExpansionInfo
public SearchResponse.Builder clearQueryExpansionInfo()
Query expansion information for the returned results.
.google.cloud.discoveryengine.v1beta.SearchResponse.QueryExpansionInfo query_expansion_info = 14;
-
getQueryExpansionInfoBuilder
public SearchResponse.QueryExpansionInfo.Builder getQueryExpansionInfoBuilder()
Query expansion information for the returned results.
.google.cloud.discoveryengine.v1beta.SearchResponse.QueryExpansionInfo query_expansion_info = 14;
-
getQueryExpansionInfoOrBuilder
public SearchResponse.QueryExpansionInfoOrBuilder getQueryExpansionInfoOrBuilder()
Query expansion information for the returned results.
.google.cloud.discoveryengine.v1beta.SearchResponse.QueryExpansionInfo query_expansion_info = 14;- Specified by:
getQueryExpansionInfoOrBuilderin interfaceSearchResponseOrBuilder
-
setUnknownFields
public final SearchResponse.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Builder>
-
mergeUnknownFields
public final SearchResponse.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.Builder>
-
-