SearchRequest.Builder (proto-google-cloud-discoveryengine-v1 0.84.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessage.Builder<SearchRequest.Builder>
    - - com.google.cloud.discoveryengine.v1.SearchRequest.Builder

All Implemented Interfaces:

SearchRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

SearchRequest
```
public static final class SearchRequest.Builder
extends com.google.protobuf.GeneratedMessage.Builder<SearchRequest.Builder>
implements SearchRequestOrBuilder
```
```
 Request message for
 [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
 method.
 
```
Protobuf type google.cloud.discoveryengine.v1.SearchRequest

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`SearchRequest.Builder`	`addAllCrowdingSpecs(Iterable<? extends SearchRequest.CrowdingSpec> values)` Optional.
`SearchRequest.Builder`	`addAllDataStoreSpecs(Iterable<? extends SearchRequest.DataStoreSpec> values)` Specifications that define the specific [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched, along with configurations for those data stores.
`SearchRequest.Builder`	`addAllFacetSpecs(Iterable<? extends SearchRequest.FacetSpec> values)` Facet specifications for faceted search.
`SearchRequest.Builder`	`addAllPageCategories(Iterable<String> values)` Optional.
`SearchRequest.Builder`	`addCrowdingSpecs(int index, SearchRequest.CrowdingSpec.Builder builderForValue)` Optional.
`SearchRequest.Builder`	`addCrowdingSpecs(int index, SearchRequest.CrowdingSpec value)` Optional.
`SearchRequest.Builder`	`addCrowdingSpecs(SearchRequest.CrowdingSpec.Builder builderForValue)` Optional.
`SearchRequest.Builder`	`addCrowdingSpecs(SearchRequest.CrowdingSpec value)` Optional.
`SearchRequest.CrowdingSpec.Builder`	`addCrowdingSpecsBuilder()` Optional.
`SearchRequest.CrowdingSpec.Builder`	`addCrowdingSpecsBuilder(int index)` Optional.
`SearchRequest.Builder`	`addDataStoreSpecs(int index, SearchRequest.DataStoreSpec.Builder builderForValue)` Specifications that define the specific [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched, along with configurations for those data stores.
`SearchRequest.Builder`	`addDataStoreSpecs(int index, SearchRequest.DataStoreSpec value)` Specifications that define the specific [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched, along with configurations for those data stores.
`SearchRequest.Builder`	`addDataStoreSpecs(SearchRequest.DataStoreSpec.Builder builderForValue)` Specifications that define the specific [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched, along with configurations for those data stores.
`SearchRequest.Builder`	`addDataStoreSpecs(SearchRequest.DataStoreSpec value)` Specifications that define the specific [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched, along with configurations for those data stores.
`SearchRequest.DataStoreSpec.Builder`	`addDataStoreSpecsBuilder()` Specifications that define the specific [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched, along with configurations for those data stores.
`SearchRequest.DataStoreSpec.Builder`	`addDataStoreSpecsBuilder(int index)` Specifications that define the specific [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched, along with configurations for those data stores.
`SearchRequest.Builder`	`addFacetSpecs(int index, SearchRequest.FacetSpec.Builder builderForValue)` Facet specifications for faceted search.
`SearchRequest.Builder`	`addFacetSpecs(int index, SearchRequest.FacetSpec value)` Facet specifications for faceted search.
`SearchRequest.Builder`	`addFacetSpecs(SearchRequest.FacetSpec.Builder builderForValue)` Facet specifications for faceted search.
`SearchRequest.Builder`	`addFacetSpecs(SearchRequest.FacetSpec value)` Facet specifications for faceted search.
`SearchRequest.FacetSpec.Builder`	`addFacetSpecsBuilder()` Facet specifications for faceted search.
`SearchRequest.FacetSpec.Builder`	`addFacetSpecsBuilder(int index)` Facet specifications for faceted search.
`SearchRequest.Builder`	`addPageCategories(String value)` Optional.
`SearchRequest.Builder`	`addPageCategoriesBytes(com.google.protobuf.ByteString value)` Optional.
`SearchRequest`	`build()`
`SearchRequest`	`buildPartial()`
`SearchRequest.Builder`	`clear()`
`SearchRequest.Builder`	`clearBoostSpec()` Boost specification to boost certain documents.
`SearchRequest.Builder`	`clearBranch()` The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.
`SearchRequest.Builder`	`clearCanonicalFilter()` The default filter that is applied when a user performs a search without checking any filters on the search page.
`SearchRequest.Builder`	`clearContentSearchSpec()` A specification for configuring the behavior of content search.
`SearchRequest.Builder`	`clearCrowdingSpecs()` Optional.
`SearchRequest.Builder`	`clearDataStoreSpecs()` Specifications that define the specific [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched, along with configurations for those data stores.
`SearchRequest.Builder`	`clearDisplaySpec()` Optional.
`SearchRequest.Builder`	`clearFacetSpecs()` Facet specifications for faceted search.
`SearchRequest.Builder`	`clearFilter()` The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.
`SearchRequest.Builder`	`clearImageQuery()` Raw image query.
`SearchRequest.Builder`	`clearLanguageCode()` The BCP-47 language code, such as "en-US" or "sr-Latn".
`SearchRequest.Builder`	`clearNaturalLanguageQueryUnderstandingSpec()` Optional.
`SearchRequest.Builder`	`clearOffset()` A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the [Document][google.cloud.discoveryengine.v1.Document]s deemed by the API as relevant) in search results.
`SearchRequest.Builder`	`clearOneBoxPageSize()` The maximum number of results to return for OneBox.
`SearchRequest.Builder`	`clearOrderBy()` The order in which documents are returned.
`SearchRequest.Builder`	`clearPageCategories()` Optional.
`SearchRequest.Builder`	`clearPageSize()` Maximum number of [Document][google.cloud.discoveryengine.v1.Document]s to return.
`SearchRequest.Builder`	`clearPageToken()` A page token received from a previous [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] call.
`SearchRequest.Builder`	`clearParams()`
`SearchRequest.Builder`	`clearQuery()` Raw search query.
`SearchRequest.Builder`	`clearQueryExpansionSpec()` The query expansion specification that specifies the conditions under which query expansion occurs.
`SearchRequest.Builder`	`clearRankingExpression()` Optional.
`SearchRequest.Builder`	`clearRankingExpressionBackend()` Optional.
`SearchRequest.Builder`	`clearRelevanceScoreSpec()` Optional.
`SearchRequest.Builder`	`clearRelevanceThreshold()` The global relevance threshold of the search results.
`SearchRequest.Builder`	`clearSafeSearch()` Whether to turn on safe search.
`SearchRequest.Builder`	`clearSearchAsYouTypeSpec()` Search as you type configuration.
`SearchRequest.Builder`	`clearServingConfig()` Required.
`SearchRequest.Builder`	`clearSession()` The session resource name.
`SearchRequest.Builder`	`clearSessionSpec()` Session specification.
`SearchRequest.Builder`	`clearSpellCorrectionSpec()` The spell correction specification that specifies the mode under which spell correction takes effect.
`SearchRequest.Builder`	`clearUserInfo()` Information about the end user.
`SearchRequest.Builder`	`clearUserLabels()`
`SearchRequest.Builder`	`clearUserPseudoId()` Optional.
`boolean`	`containsParams(String key)` Additional search parameters.
`boolean`	`containsUserLabels(String key)` The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
`SearchRequest.BoostSpec`	`getBoostSpec()` Boost specification to boost certain documents.
`SearchRequest.BoostSpec.Builder`	`getBoostSpecBuilder()` Boost specification to boost certain documents.
`SearchRequest.BoostSpecOrBuilder`	`getBoostSpecOrBuilder()` Boost specification to boost certain documents.
`String`	`getBranch()` The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.
`com.google.protobuf.ByteString`	`getBranchBytes()` The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.
`String`	`getCanonicalFilter()` The default filter that is applied when a user performs a search without checking any filters on the search page.
`com.google.protobuf.ByteString`	`getCanonicalFilterBytes()` The default filter that is applied when a user performs a search without checking any filters on the search page.
`SearchRequest.ContentSearchSpec`	`getContentSearchSpec()` A specification for configuring the behavior of content search.
`SearchRequest.ContentSearchSpec.Builder`	`getContentSearchSpecBuilder()` A specification for configuring the behavior of content search.
`SearchRequest.ContentSearchSpecOrBuilder`	`getContentSearchSpecOrBuilder()` A specification for configuring the behavior of content search.
`SearchRequest.CrowdingSpec`	`getCrowdingSpecs(int index)` Optional.
`SearchRequest.CrowdingSpec.Builder`	`getCrowdingSpecsBuilder(int index)` Optional.
`List<SearchRequest.CrowdingSpec.Builder>`	`getCrowdingSpecsBuilderList()` Optional.
`int`	`getCrowdingSpecsCount()` Optional.
`List<SearchRequest.CrowdingSpec>`	`getCrowdingSpecsList()` Optional.
`SearchRequest.CrowdingSpecOrBuilder`	`getCrowdingSpecsOrBuilder(int index)` Optional.
`List<? extends SearchRequest.CrowdingSpecOrBuilder>`	`getCrowdingSpecsOrBuilderList()` Optional.
`SearchRequest.DataStoreSpec`	`getDataStoreSpecs(int index)` Specifications that define the specific [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched, along with configurations for those data stores.
`SearchRequest.DataStoreSpec.Builder`	`getDataStoreSpecsBuilder(int index)` Specifications that define the specific [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched, along with configurations for those data stores.
`List<SearchRequest.DataStoreSpec.Builder>`	`getDataStoreSpecsBuilderList()` Specifications that define the specific [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched, along with configurations for those data stores.
`int`	`getDataStoreSpecsCount()` Specifications that define the specific [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched, along with configurations for those data stores.
`List<SearchRequest.DataStoreSpec>`	`getDataStoreSpecsList()` Specifications that define the specific [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched, along with configurations for those data stores.
`SearchRequest.DataStoreSpecOrBuilder`	`getDataStoreSpecsOrBuilder(int index)` Specifications that define the specific [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched, along with configurations for those data stores.
`List<? extends SearchRequest.DataStoreSpecOrBuilder>`	`getDataStoreSpecsOrBuilderList()` Specifications that define the specific [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched, along with configurations for those data stores.
`SearchRequest`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`SearchRequest.DisplaySpec`	`getDisplaySpec()` Optional.
`SearchRequest.DisplaySpec.Builder`	`getDisplaySpecBuilder()` Optional.
`SearchRequest.DisplaySpecOrBuilder`	`getDisplaySpecOrBuilder()` Optional.
`SearchRequest.FacetSpec`	`getFacetSpecs(int index)` Facet specifications for faceted search.
`SearchRequest.FacetSpec.Builder`	`getFacetSpecsBuilder(int index)` Facet specifications for faceted search.
`List<SearchRequest.FacetSpec.Builder>`	`getFacetSpecsBuilderList()` Facet specifications for faceted search.
`int`	`getFacetSpecsCount()` Facet specifications for faceted search.
`List<SearchRequest.FacetSpec>`	`getFacetSpecsList()` Facet specifications for faceted search.
`SearchRequest.FacetSpecOrBuilder`	`getFacetSpecsOrBuilder(int index)` Facet specifications for faceted search.
`List<? extends SearchRequest.FacetSpecOrBuilder>`	`getFacetSpecsOrBuilderList()` Facet specifications for faceted search.
`String`	`getFilter()` The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.
`com.google.protobuf.ByteString`	`getFilterBytes()` The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.
`SearchRequest.ImageQuery`	`getImageQuery()` Raw image query.
`SearchRequest.ImageQuery.Builder`	`getImageQueryBuilder()` Raw image query.
`SearchRequest.ImageQueryOrBuilder`	`getImageQueryOrBuilder()` Raw image query.
`String`	`getLanguageCode()` The BCP-47 language code, such as "en-US" or "sr-Latn".
`com.google.protobuf.ByteString`	`getLanguageCodeBytes()` The BCP-47 language code, such as "en-US" or "sr-Latn".
`Map<String,com.google.protobuf.Value>`	`getMutableParams()` Deprecated.
`Map<String,String>`	`getMutableUserLabels()` Deprecated.
`SearchRequest.NaturalLanguageQueryUnderstandingSpec`	`getNaturalLanguageQueryUnderstandingSpec()` Optional.
`SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder`	`getNaturalLanguageQueryUnderstandingSpecBuilder()` Optional.
`SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder`	`getNaturalLanguageQueryUnderstandingSpecOrBuilder()` Optional.
`int`	`getOffset()` A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the [Document][google.cloud.discoveryengine.v1.Document]s deemed by the API as relevant) in search results.
`int`	`getOneBoxPageSize()` The maximum number of results to return for OneBox.
`String`	`getOrderBy()` The order in which documents are returned.
`com.google.protobuf.ByteString`	`getOrderByBytes()` The order in which documents are returned.
`String`	`getPageCategories(int index)` Optional.
`com.google.protobuf.ByteString`	`getPageCategoriesBytes(int index)` Optional.
`int`	`getPageCategoriesCount()` Optional.
`com.google.protobuf.ProtocolStringList`	`getPageCategoriesList()` Optional.
`int`	`getPageSize()` Maximum number of [Document][google.cloud.discoveryengine.v1.Document]s to return.
`String`	`getPageToken()` A page token received from a previous [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] call.
`com.google.protobuf.ByteString`	`getPageTokenBytes()` A page token received from a previous [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] call.
`Map<String,com.google.protobuf.Value>`	`getParams()` Deprecated.
`int`	`getParamsCount()` Additional search parameters.
`Map<String,com.google.protobuf.Value>`	`getParamsMap()` Additional search parameters.
`com.google.protobuf.Value`	`getParamsOrDefault(String key, com.google.protobuf.Value defaultValue)` Additional search parameters.
`com.google.protobuf.Value`	`getParamsOrThrow(String key)` Additional search parameters.
`String`	`getQuery()` Raw search query.
`com.google.protobuf.ByteString`	`getQueryBytes()` Raw search query.
`SearchRequest.QueryExpansionSpec`	`getQueryExpansionSpec()` The query expansion specification that specifies the conditions under which query expansion occurs.
`SearchRequest.QueryExpansionSpec.Builder`	`getQueryExpansionSpecBuilder()` The query expansion specification that specifies the conditions under which query expansion occurs.
`SearchRequest.QueryExpansionSpecOrBuilder`	`getQueryExpansionSpecOrBuilder()` The query expansion specification that specifies the conditions under which query expansion occurs.
`String`	`getRankingExpression()` Optional.
`SearchRequest.RankingExpressionBackend`	`getRankingExpressionBackend()` Optional.
`int`	`getRankingExpressionBackendValue()` Optional.
`com.google.protobuf.ByteString`	`getRankingExpressionBytes()` Optional.
`SearchRequest.RelevanceScoreSpec`	`getRelevanceScoreSpec()` Optional.
`SearchRequest.RelevanceScoreSpec.Builder`	`getRelevanceScoreSpecBuilder()` Optional.
`SearchRequest.RelevanceScoreSpecOrBuilder`	`getRelevanceScoreSpecOrBuilder()` Optional.
`SearchRequest.RelevanceThreshold`	`getRelevanceThreshold()` The global relevance threshold of the search results.
`int`	`getRelevanceThresholdValue()` The global relevance threshold of the search results.
`boolean`	`getSafeSearch()` Whether to turn on safe search.
`SearchRequest.SearchAsYouTypeSpec`	`getSearchAsYouTypeSpec()` Search as you type configuration.
`SearchRequest.SearchAsYouTypeSpec.Builder`	`getSearchAsYouTypeSpecBuilder()` Search as you type configuration.
`SearchRequest.SearchAsYouTypeSpecOrBuilder`	`getSearchAsYouTypeSpecOrBuilder()` Search as you type configuration.
`String`	`getServingConfig()` Required.
`com.google.protobuf.ByteString`	`getServingConfigBytes()` Required.
`String`	`getSession()` The session resource name.
`com.google.protobuf.ByteString`	`getSessionBytes()` The session resource name.
`SearchRequest.SessionSpec`	`getSessionSpec()` Session specification.
`SearchRequest.SessionSpec.Builder`	`getSessionSpecBuilder()` Session specification.
`SearchRequest.SessionSpecOrBuilder`	`getSessionSpecOrBuilder()` Session specification.
`SearchRequest.SpellCorrectionSpec`	`getSpellCorrectionSpec()` The spell correction specification that specifies the mode under which spell correction takes effect.
`SearchRequest.SpellCorrectionSpec.Builder`	`getSpellCorrectionSpecBuilder()` The spell correction specification that specifies the mode under which spell correction takes effect.
`SearchRequest.SpellCorrectionSpecOrBuilder`	`getSpellCorrectionSpecOrBuilder()` The spell correction specification that specifies the mode under which spell correction takes effect.
`UserInfo`	`getUserInfo()` Information about the end user.
`UserInfo.Builder`	`getUserInfoBuilder()` Information about the end user.
`UserInfoOrBuilder`	`getUserInfoOrBuilder()` Information about the end user.
`Map<String,String>`	`getUserLabels()` Deprecated.
`int`	`getUserLabelsCount()` The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
`Map<String,String>`	`getUserLabelsMap()` The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
`String`	`getUserLabelsOrDefault(String key, String defaultValue)` The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
`String`	`getUserLabelsOrThrow(String key)` The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
`String`	`getUserPseudoId()` Optional.
`com.google.protobuf.ByteString`	`getUserPseudoIdBytes()` Optional.
`boolean`	`hasBoostSpec()` Boost specification to boost certain documents.
`boolean`	`hasContentSearchSpec()` A specification for configuring the behavior of content search.
`boolean`	`hasDisplaySpec()` Optional.
`boolean`	`hasImageQuery()` Raw image query.
`boolean`	`hasNaturalLanguageQueryUnderstandingSpec()` Optional.
`boolean`	`hasQueryExpansionSpec()` The query expansion specification that specifies the conditions under which query expansion occurs.
`boolean`	`hasRelevanceScoreSpec()` Optional.
`boolean`	`hasSearchAsYouTypeSpec()` Search as you type configuration.
`boolean`	`hasSessionSpec()` Session specification.
`boolean`	`hasSpellCorrectionSpec()` The spell correction specification that specifies the mode under which spell correction takes effect.
`boolean`	`hasUserInfo()` Information about the end user.
`protected com.google.protobuf.GeneratedMessage.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapFieldReflectionAccessor`	`internalGetMapFieldReflection(int number)`
`protected com.google.protobuf.MapFieldReflectionAccessor`	`internalGetMutableMapFieldReflection(int number)`
`boolean`	`isInitialized()`
`SearchRequest.Builder`	`mergeBoostSpec(SearchRequest.BoostSpec value)` Boost specification to boost certain documents.
`SearchRequest.Builder`	`mergeContentSearchSpec(SearchRequest.ContentSearchSpec value)` A specification for configuring the behavior of content search.
`SearchRequest.Builder`	`mergeDisplaySpec(SearchRequest.DisplaySpec value)` Optional.
`SearchRequest.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`SearchRequest.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`SearchRequest.Builder`	`mergeFrom(SearchRequest other)`
`SearchRequest.Builder`	`mergeImageQuery(SearchRequest.ImageQuery value)` Raw image query.
`SearchRequest.Builder`	`mergeNaturalLanguageQueryUnderstandingSpec(SearchRequest.NaturalLanguageQueryUnderstandingSpec value)` Optional.
`SearchRequest.Builder`	`mergeQueryExpansionSpec(SearchRequest.QueryExpansionSpec value)` The query expansion specification that specifies the conditions under which query expansion occurs.
`SearchRequest.Builder`	`mergeRelevanceScoreSpec(SearchRequest.RelevanceScoreSpec value)` Optional.
`SearchRequest.Builder`	`mergeSearchAsYouTypeSpec(SearchRequest.SearchAsYouTypeSpec value)` Search as you type configuration.
`SearchRequest.Builder`	`mergeSessionSpec(SearchRequest.SessionSpec value)` Session specification.
`SearchRequest.Builder`	`mergeSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec value)` The spell correction specification that specifies the mode under which spell correction takes effect.
`SearchRequest.Builder`	`mergeUserInfo(UserInfo value)` Information about the end user.
`SearchRequest.Builder`	`putAllParams(Map<String,com.google.protobuf.Value> values)` Additional search parameters.
`SearchRequest.Builder`	`putAllUserLabels(Map<String,String> values)` The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
`SearchRequest.Builder`	`putParams(String key, com.google.protobuf.Value value)` Additional search parameters.
`com.google.protobuf.Value.Builder`	`putParamsBuilderIfAbsent(String key)` Additional search parameters.
`SearchRequest.Builder`	`putUserLabels(String key, String value)` The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
`SearchRequest.Builder`	`removeCrowdingSpecs(int index)` Optional.
`SearchRequest.Builder`	`removeDataStoreSpecs(int index)` Specifications that define the specific [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched, along with configurations for those data stores.
`SearchRequest.Builder`	`removeFacetSpecs(int index)` Facet specifications for faceted search.
`SearchRequest.Builder`	`removeParams(String key)` Additional search parameters.
`SearchRequest.Builder`	`removeUserLabels(String key)` The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
`SearchRequest.Builder`	`setBoostSpec(SearchRequest.BoostSpec.Builder builderForValue)` Boost specification to boost certain documents.
`SearchRequest.Builder`	`setBoostSpec(SearchRequest.BoostSpec value)` Boost specification to boost certain documents.
`SearchRequest.Builder`	`setBranch(String value)` The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.
`SearchRequest.Builder`	`setBranchBytes(com.google.protobuf.ByteString value)` The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.
`SearchRequest.Builder`	`setCanonicalFilter(String value)` The default filter that is applied when a user performs a search without checking any filters on the search page.
`SearchRequest.Builder`	`setCanonicalFilterBytes(com.google.protobuf.ByteString value)` The default filter that is applied when a user performs a search without checking any filters on the search page.
`SearchRequest.Builder`	`setContentSearchSpec(SearchRequest.ContentSearchSpec.Builder builderForValue)` A specification for configuring the behavior of content search.
`SearchRequest.Builder`	`setContentSearchSpec(SearchRequest.ContentSearchSpec value)` A specification for configuring the behavior of content search.
`SearchRequest.Builder`	`setCrowdingSpecs(int index, SearchRequest.CrowdingSpec.Builder builderForValue)` Optional.
`SearchRequest.Builder`	`setCrowdingSpecs(int index, SearchRequest.CrowdingSpec value)` Optional.
`SearchRequest.Builder`	`setDataStoreSpecs(int index, SearchRequest.DataStoreSpec.Builder builderForValue)` Specifications that define the specific [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched, along with configurations for those data stores.
`SearchRequest.Builder`	`setDataStoreSpecs(int index, SearchRequest.DataStoreSpec value)` Specifications that define the specific [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched, along with configurations for those data stores.
`SearchRequest.Builder`	`setDisplaySpec(SearchRequest.DisplaySpec.Builder builderForValue)` Optional.
`SearchRequest.Builder`	`setDisplaySpec(SearchRequest.DisplaySpec value)` Optional.
`SearchRequest.Builder`	`setFacetSpecs(int index, SearchRequest.FacetSpec.Builder builderForValue)` Facet specifications for faceted search.
`SearchRequest.Builder`	`setFacetSpecs(int index, SearchRequest.FacetSpec value)` Facet specifications for faceted search.
`SearchRequest.Builder`	`setFilter(String value)` The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.
`SearchRequest.Builder`	`setFilterBytes(com.google.protobuf.ByteString value)` The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.
`SearchRequest.Builder`	`setImageQuery(SearchRequest.ImageQuery.Builder builderForValue)` Raw image query.
`SearchRequest.Builder`	`setImageQuery(SearchRequest.ImageQuery value)` Raw image query.
`SearchRequest.Builder`	`setLanguageCode(String value)` The BCP-47 language code, such as "en-US" or "sr-Latn".
`SearchRequest.Builder`	`setLanguageCodeBytes(com.google.protobuf.ByteString value)` The BCP-47 language code, such as "en-US" or "sr-Latn".
`SearchRequest.Builder`	`setNaturalLanguageQueryUnderstandingSpec(SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder builderForValue)` Optional.
`SearchRequest.Builder`	`setNaturalLanguageQueryUnderstandingSpec(SearchRequest.NaturalLanguageQueryUnderstandingSpec value)` Optional.
`SearchRequest.Builder`	`setOffset(int value)` A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the [Document][google.cloud.discoveryengine.v1.Document]s deemed by the API as relevant) in search results.
`SearchRequest.Builder`	`setOneBoxPageSize(int value)` The maximum number of results to return for OneBox.
`SearchRequest.Builder`	`setOrderBy(String value)` The order in which documents are returned.
`SearchRequest.Builder`	`setOrderByBytes(com.google.protobuf.ByteString value)` The order in which documents are returned.
`SearchRequest.Builder`	`setPageCategories(int index, String value)` Optional.
`SearchRequest.Builder`	`setPageSize(int value)` Maximum number of [Document][google.cloud.discoveryengine.v1.Document]s to return.
`SearchRequest.Builder`	`setPageToken(String value)` A page token received from a previous [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] call.
`SearchRequest.Builder`	`setPageTokenBytes(com.google.protobuf.ByteString value)` A page token received from a previous [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] call.
`SearchRequest.Builder`	`setQuery(String value)` Raw search query.
`SearchRequest.Builder`	`setQueryBytes(com.google.protobuf.ByteString value)` Raw search query.
`SearchRequest.Builder`	`setQueryExpansionSpec(SearchRequest.QueryExpansionSpec.Builder builderForValue)` The query expansion specification that specifies the conditions under which query expansion occurs.
`SearchRequest.Builder`	`setQueryExpansionSpec(SearchRequest.QueryExpansionSpec value)` The query expansion specification that specifies the conditions under which query expansion occurs.
`SearchRequest.Builder`	`setRankingExpression(String value)` Optional.
`SearchRequest.Builder`	`setRankingExpressionBackend(SearchRequest.RankingExpressionBackend value)` Optional.
`SearchRequest.Builder`	`setRankingExpressionBackendValue(int value)` Optional.
`SearchRequest.Builder`	`setRankingExpressionBytes(com.google.protobuf.ByteString value)` Optional.
`SearchRequest.Builder`	`setRelevanceScoreSpec(SearchRequest.RelevanceScoreSpec.Builder builderForValue)` Optional.
`SearchRequest.Builder`	`setRelevanceScoreSpec(SearchRequest.RelevanceScoreSpec value)` Optional.
`SearchRequest.Builder`	`setRelevanceThreshold(SearchRequest.RelevanceThreshold value)` The global relevance threshold of the search results.
`SearchRequest.Builder`	`setRelevanceThresholdValue(int value)` The global relevance threshold of the search results.
`SearchRequest.Builder`	`setSafeSearch(boolean value)` Whether to turn on safe search.
`SearchRequest.Builder`	`setSearchAsYouTypeSpec(SearchRequest.SearchAsYouTypeSpec.Builder builderForValue)` Search as you type configuration.
`SearchRequest.Builder`	`setSearchAsYouTypeSpec(SearchRequest.SearchAsYouTypeSpec value)` Search as you type configuration.
`SearchRequest.Builder`	`setServingConfig(String value)` Required.
`SearchRequest.Builder`	`setServingConfigBytes(com.google.protobuf.ByteString value)` Required.
`SearchRequest.Builder`	`setSession(String value)` The session resource name.
`SearchRequest.Builder`	`setSessionBytes(com.google.protobuf.ByteString value)` The session resource name.
`SearchRequest.Builder`	`setSessionSpec(SearchRequest.SessionSpec.Builder builderForValue)` Session specification.
`SearchRequest.Builder`	`setSessionSpec(SearchRequest.SessionSpec value)` Session specification.
`SearchRequest.Builder`	`setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec.Builder builderForValue)` The spell correction specification that specifies the mode under which spell correction takes effect.
`SearchRequest.Builder`	`setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec value)` The spell correction specification that specifies the mode under which spell correction takes effect.
`SearchRequest.Builder`	`setUserInfo(UserInfo.Builder builderForValue)` Information about the end user.
`SearchRequest.Builder`	`setUserInfo(UserInfo value)` Information about the end user.
`SearchRequest.Builder`	`setUserPseudoId(String value)` Optional.
`SearchRequest.Builder`	`setUserPseudoIdBytes(com.google.protobuf.ByteString value)` Optional.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, 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

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapFieldReflection
```
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
```
Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<SearchRequest.Builder>

internalGetMutableMapFieldReflection
```
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
```
Overrides:

internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<SearchRequest.Builder>

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<SearchRequest.Builder>

clear
```
public SearchRequest.Builder clear()
```
Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<SearchRequest.Builder>

getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<SearchRequest.Builder>

getDefaultInstanceForType
```
public SearchRequest getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public SearchRequest build()
```
Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial
```
public SearchRequest buildPartial()
```
Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom
```
public SearchRequest.Builder mergeFrom(com.google.protobuf.Message other)
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchRequest.Builder>

mergeFrom

public SearchRequest.Builder mergeFrom(SearchRequest other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<SearchRequest.Builder>

mergeFrom
```
public SearchRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchRequest.Builder>

Throws:

IOException

getServingConfig

public String getServingConfig()

 Required. The resource name of the Search serving config, such as
 `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`,
 or
 `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
 This field is used to identify the serving configuration name, set
 of models used to make the search.


 string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:: getServingConfig in interface SearchRequestOrBuilder
Returns:: The servingConfig.

getServingConfigBytes

public com.google.protobuf.ByteString getServingConfigBytes()

 Required. The resource name of the Search serving config, such as
 `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`,
 or
 `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
 This field is used to identify the serving configuration name, set
 of models used to make the search.


 string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:: getServingConfigBytes in interface SearchRequestOrBuilder
Returns:: The bytes for servingConfig.

setServingConfig

public SearchRequest.Builder setServingConfig(String value)

 Required. The resource name of the Search serving config, such as
 `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`,
 or
 `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
 This field is used to identify the serving configuration name, set
 of models used to make the search.


 string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameters:: value - The servingConfig to set.
Returns:: This builder for chaining.

clearServingConfig

public SearchRequest.Builder clearServingConfig()

 Required. The resource name of the Search serving config, such as
 `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`,
 or
 `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
 This field is used to identify the serving configuration name, set
 of models used to make the search.


 string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:: This builder for chaining.

setServingConfigBytes

public SearchRequest.Builder setServingConfigBytes(com.google.protobuf.ByteString value)

 Required. The resource name of the Search serving config, such as
 `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`,
 or
 `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
 This field is used to identify the serving configuration name, set
 of models used to make the search.


 string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameters:: value - The bytes for servingConfig to set.
Returns:: This builder for chaining.

getBranch

public String getBranch()

 The branch resource name, such as
 `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.

 Use `default_branch` as the branch ID or leave this field empty, to search
 documents under the default branch.

string branch = 2 [(.google.api.resource_reference) = { ... }

Specified by:: getBranch in interface SearchRequestOrBuilder
Returns:: The branch.

getBranchBytes

public com.google.protobuf.ByteString getBranchBytes()

 The branch resource name, such as
 `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.

 Use `default_branch` as the branch ID or leave this field empty, to search
 documents under the default branch.

string branch = 2 [(.google.api.resource_reference) = { ... }

Specified by:: getBranchBytes in interface SearchRequestOrBuilder
Returns:: The bytes for branch.

setBranch

public SearchRequest.Builder setBranch(String value)

 The branch resource name, such as
 `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.

 Use `default_branch` as the branch ID or leave this field empty, to search
 documents under the default branch.

string branch = 2 [(.google.api.resource_reference) = { ... }

Parameters:: value - The branch to set.
Returns:: This builder for chaining.

clearBranch

public SearchRequest.Builder clearBranch()

 The branch resource name, such as
 `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.

 Use `default_branch` as the branch ID or leave this field empty, to search
 documents under the default branch.

string branch = 2 [(.google.api.resource_reference) = { ... }

Returns:: This builder for chaining.

setBranchBytes

public SearchRequest.Builder setBranchBytes(com.google.protobuf.ByteString value)

 The branch resource name, such as
 `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.

 Use `default_branch` as the branch ID or leave this field empty, to search
 documents under the default branch.

string branch = 2 [(.google.api.resource_reference) = { ... }

Parameters:: value - The bytes for branch to set.
Returns:: This builder for chaining.

getQuery
```
public String getQuery()
```
```
 Raw search query.
 
```
string query = 3;
Specified by:

getQuery in interface SearchRequestOrBuilder

Returns:

The query.

getQueryBytes
```
public com.google.protobuf.ByteString getQueryBytes()
```
```
 Raw search query.
 
```
string query = 3;
Specified by:

getQueryBytes in interface SearchRequestOrBuilder

Returns:

The bytes for query.

setQuery
```
public SearchRequest.Builder setQuery(String value)
```
```
 Raw search query.
 
```
string query = 3;
Parameters:

value - The query to set.

Returns:

This builder for chaining.

clearQuery

public SearchRequest.Builder clearQuery()

 Raw search query.

string query = 3;

Returns:: This builder for chaining.

setQueryBytes

public SearchRequest.Builder setQueryBytes(com.google.protobuf.ByteString value)

 Raw search query.

string query = 3;

Parameters:: value - The bytes for query to set.
Returns:: This builder for chaining.

getPageCategoriesList

public com.google.protobuf.ProtocolStringList getPageCategoriesList()

 Optional. The categories associated with a category page. Must be set for
 category navigation queries to achieve good search quality. The format
 should be the same as
 [PageInfo.page_category][google.cloud.discoveryengine.v1.PageInfo.page_category].
 This field is the equivalent of the query for browse (navigation) queries.
 It's used by the browse model when the query is empty.

 If the field is empty, it will not be used by the browse model.
 If the field contains more than one element, only the first element will
 be used.

 To represent full path of a category, use '>' character to separate
 different hierarchies. If '>' is part of the category name, replace it with
 other character(s).
 For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX >
 4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090
 > Founders Edition`

repeated string page_categories = 63 [(.google.api.field_behavior) = OPTIONAL];

Specified by:: getPageCategoriesList in interface SearchRequestOrBuilder
Returns:: A list containing the pageCategories.

getPageCategoriesCount

public int getPageCategoriesCount()

 Optional. The categories associated with a category page. Must be set for
 category navigation queries to achieve good search quality. The format
 should be the same as
 [PageInfo.page_category][google.cloud.discoveryengine.v1.PageInfo.page_category].
 This field is the equivalent of the query for browse (navigation) queries.
 It's used by the browse model when the query is empty.

 If the field is empty, it will not be used by the browse model.
 If the field contains more than one element, only the first element will
 be used.

 To represent full path of a category, use '>' character to separate
 different hierarchies. If '>' is part of the category name, replace it with
 other character(s).
 For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX >
 4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090
 > Founders Edition`

repeated string page_categories = 63 [(.google.api.field_behavior) = OPTIONAL];

Specified by:: getPageCategoriesCount in interface SearchRequestOrBuilder
Returns:: The count of pageCategories.

getPageCategories

public String getPageCategories(int index)

 Optional. The categories associated with a category page. Must be set for
 category navigation queries to achieve good search quality. The format
 should be the same as
 [PageInfo.page_category][google.cloud.discoveryengine.v1.PageInfo.page_category].
 This field is the equivalent of the query for browse (navigation) queries.
 It's used by the browse model when the query is empty.

 If the field is empty, it will not be used by the browse model.
 If the field contains more than one element, only the first element will
 be used.

 To represent full path of a category, use '>' character to separate
 different hierarchies. If '>' is part of the category name, replace it with
 other character(s).
 For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX >
 4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090
 > Founders Edition`

repeated string page_categories = 63 [(.google.api.field_behavior) = OPTIONAL];

Specified by:: getPageCategories in interface SearchRequestOrBuilder
Parameters:: index - The index of the element to return.
Returns:: The pageCategories at the given index.

getPageCategoriesBytes

public com.google.protobuf.ByteString getPageCategoriesBytes(int index)

 Optional. The categories associated with a category page. Must be set for
 category navigation queries to achieve good search quality. The format
 should be the same as
 [PageInfo.page_category][google.cloud.discoveryengine.v1.PageInfo.page_category].
 This field is the equivalent of the query for browse (navigation) queries.
 It's used by the browse model when the query is empty.

 If the field is empty, it will not be used by the browse model.
 If the field contains more than one element, only the first element will
 be used.

 To represent full path of a category, use '>' character to separate
 different hierarchies. If '>' is part of the category name, replace it with
 other character(s).
 For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX >
 4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090
 > Founders Edition`

repeated string page_categories = 63 [(.google.api.field_behavior) = OPTIONAL];

Specified by:: getPageCategoriesBytes in interface SearchRequestOrBuilder
Parameters:: index - The index of the value to return.
Returns:: The bytes of the pageCategories at the given index.

setPageCategories

public SearchRequest.Builder setPageCategories(int index,
                                               String value)

 Optional. The categories associated with a category page. Must be set for
 category navigation queries to achieve good search quality. The format
 should be the same as
 [PageInfo.page_category][google.cloud.discoveryengine.v1.PageInfo.page_category].
 This field is the equivalent of the query for browse (navigation) queries.
 It's used by the browse model when the query is empty.

 If the field is empty, it will not be used by the browse model.
 If the field contains more than one element, only the first element will
 be used.

 To represent full path of a category, use '>' character to separate
 different hierarchies. If '>' is part of the category name, replace it with
 other character(s).
 For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX >
 4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090
 > Founders Edition`

repeated string page_categories = 63 [(.google.api.field_behavior) = OPTIONAL];

Parameters:: index - The index to set the value at.; value - The pageCategories to set.
Returns:: This builder for chaining.

addPageCategories

public SearchRequest.Builder addPageCategories(String value)

 Optional. The categories associated with a category page. Must be set for
 category navigation queries to achieve good search quality. The format
 should be the same as
 [PageInfo.page_category][google.cloud.discoveryengine.v1.PageInfo.page_category].
 This field is the equivalent of the query for browse (navigation) queries.
 It's used by the browse model when the query is empty.

 If the field is empty, it will not be used by the browse model.
 If the field contains more than one element, only the first element will
 be used.

 To represent full path of a category, use '>' character to separate
 different hierarchies. If '>' is part of the category name, replace it with
 other character(s).
 For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX >
 4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090
 > Founders Edition`

repeated string page_categories = 63 [(.google.api.field_behavior) = OPTIONAL];

Parameters:: value - The pageCategories to add.
Returns:: This builder for chaining.

addAllPageCategories

public SearchRequest.Builder addAllPageCategories(Iterable<String> values)

 Optional. The categories associated with a category page. Must be set for
 category navigation queries to achieve good search quality. The format
 should be the same as
 [PageInfo.page_category][google.cloud.discoveryengine.v1.PageInfo.page_category].
 This field is the equivalent of the query for browse (navigation) queries.
 It's used by the browse model when the query is empty.

 If the field is empty, it will not be used by the browse model.
 If the field contains more than one element, only the first element will
 be used.

 To represent full path of a category, use '>' character to separate
 different hierarchies. If '>' is part of the category name, replace it with
 other character(s).
 For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX >
 4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090
 > Founders Edition`

repeated string page_categories = 63 [(.google.api.field_behavior) = OPTIONAL];

Parameters:: values - The pageCategories to add.
Returns:: This builder for chaining.

clearPageCategories

public SearchRequest.Builder clearPageCategories()

 Optional. The categories associated with a category page. Must be set for
 category navigation queries to achieve good search quality. The format
 should be the same as
 [PageInfo.page_category][google.cloud.discoveryengine.v1.PageInfo.page_category].
 This field is the equivalent of the query for browse (navigation) queries.
 It's used by the browse model when the query is empty.

 If the field is empty, it will not be used by the browse model.
 If the field contains more than one element, only the first element will
 be used.

 To represent full path of a category, use '>' character to separate
 different hierarchies. If '>' is part of the category name, replace it with
 other character(s).
 For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX >
 4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090
 > Founders Edition`

repeated string page_categories = 63 [(.google.api.field_behavior) = OPTIONAL];

Returns:: This builder for chaining.

addPageCategoriesBytes

public SearchRequest.Builder addPageCategoriesBytes(com.google.protobuf.ByteString value)

 Optional. The categories associated with a category page. Must be set for
 category navigation queries to achieve good search quality. The format
 should be the same as
 [PageInfo.page_category][google.cloud.discoveryengine.v1.PageInfo.page_category].
 This field is the equivalent of the query for browse (navigation) queries.
 It's used by the browse model when the query is empty.

 If the field is empty, it will not be used by the browse model.
 If the field contains more than one element, only the first element will
 be used.

 To represent full path of a category, use '>' character to separate
 different hierarchies. If '>' is part of the category name, replace it with
 other character(s).
 For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX >
 4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090
 > Founders Edition`

repeated string page_categories = 63 [(.google.api.field_behavior) = OPTIONAL];

Parameters:: value - The bytes of the pageCategories to add.
Returns:: This builder for chaining.

hasImageQuery
```
public boolean hasImageQuery()
```
```
 Raw image query.
 
```
.google.cloud.discoveryengine.v1.SearchRequest.ImageQuery image_query = 19;
Specified by:

hasImageQuery in interface SearchRequestOrBuilder

Returns:

Whether the imageQuery field is set.

getImageQuery
```
public SearchRequest.ImageQuery getImageQuery()
```
```
 Raw image query.
 
```
.google.cloud.discoveryengine.v1.SearchRequest.ImageQuery image_query = 19;
Specified by:

getImageQuery in interface SearchRequestOrBuilder

Returns:

The imageQuery.

setImageQuery

public SearchRequest.Builder setImageQuery(SearchRequest.ImageQuery value)

 Raw image query.

.google.cloud.discoveryengine.v1.SearchRequest.ImageQuery image_query = 19;

setImageQuery

public SearchRequest.Builder setImageQuery(SearchRequest.ImageQuery.Builder builderForValue)

 Raw image query.

.google.cloud.discoveryengine.v1.SearchRequest.ImageQuery image_query = 19;

mergeImageQuery

public SearchRequest.Builder mergeImageQuery(SearchRequest.ImageQuery value)

 Raw image query.

.google.cloud.discoveryengine.v1.SearchRequest.ImageQuery image_query = 19;

clearImageQuery
```
public SearchRequest.Builder clearImageQuery()
```
```
 Raw image query.
 
```
.google.cloud.discoveryengine.v1.SearchRequest.ImageQuery image_query = 19;

getImageQueryBuilder
```
public SearchRequest.ImageQuery.Builder getImageQueryBuilder()
```
```
 Raw image query.
 
```
.google.cloud.discoveryengine.v1.SearchRequest.ImageQuery image_query = 19;

getImageQueryOrBuilder
```
public SearchRequest.ImageQueryOrBuilder getImageQueryOrBuilder()
```
```
 Raw image query.
 
```
.google.cloud.discoveryengine.v1.SearchRequest.ImageQuery image_query = 19;
Specified by:

getImageQueryOrBuilder in interface SearchRequestOrBuilder

getPageSize

public int getPageSize()

 Maximum number of [Document][google.cloud.discoveryengine.v1.Document]s to
 return. The maximum allowed value depends on the data type. Values above
 the maximum value are coerced to the maximum value.

 * Websites with basic indexing: Default `10`, Maximum `25`.
 * Websites with advanced indexing: Default `25`, Maximum `50`.
 * Other: Default `50`, Maximum `100`.

 If this field is negative, an  `INVALID_ARGUMENT` is returned.

int32 page_size = 4;

Specified by:: getPageSize in interface SearchRequestOrBuilder
Returns:: The pageSize.

setPageSize

public SearchRequest.Builder setPageSize(int value)

 Maximum number of [Document][google.cloud.discoveryengine.v1.Document]s to
 return. The maximum allowed value depends on the data type. Values above
 the maximum value are coerced to the maximum value.

 * Websites with basic indexing: Default `10`, Maximum `25`.
 * Websites with advanced indexing: Default `25`, Maximum `50`.
 * Other: Default `50`, Maximum `100`.

 If this field is negative, an  `INVALID_ARGUMENT` is returned.

int32 page_size = 4;

Parameters:: value - The pageSize to set.
Returns:: This builder for chaining.

clearPageSize

public SearchRequest.Builder clearPageSize()

 Maximum number of [Document][google.cloud.discoveryengine.v1.Document]s to
 return. The maximum allowed value depends on the data type. Values above
 the maximum value are coerced to the maximum value.

 * Websites with basic indexing: Default `10`, Maximum `25`.
 * Websites with advanced indexing: Default `25`, Maximum `50`.
 * Other: Default `50`, Maximum `100`.

 If this field is negative, an  `INVALID_ARGUMENT` is returned.

int32 page_size = 4;

Returns:: This builder for chaining.

getPageToken

public String getPageToken()

 A page token received from a previous
 [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
 must match the call that provided the page token. Otherwise, an
 `INVALID_ARGUMENT`  error is returned.

string page_token = 5;

Specified by:: getPageToken in interface SearchRequestOrBuilder
Returns:: The pageToken.

getPageTokenBytes

public com.google.protobuf.ByteString getPageTokenBytes()

 A page token received from a previous
 [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
 must match the call that provided the page token. Otherwise, an
 `INVALID_ARGUMENT`  error is returned.

string page_token = 5;

Specified by:: getPageTokenBytes in interface SearchRequestOrBuilder
Returns:: The bytes for pageToken.

setPageToken

public SearchRequest.Builder setPageToken(String value)

 A page token received from a previous
 [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
 must match the call that provided the page token. Otherwise, an
 `INVALID_ARGUMENT`  error is returned.

string page_token = 5;

Parameters:: value - The pageToken to set.
Returns:: This builder for chaining.

clearPageToken

public SearchRequest.Builder clearPageToken()

 A page token received from a previous
 [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
 must match the call that provided the page token. Otherwise, an
 `INVALID_ARGUMENT`  error is returned.

string page_token = 5;

Returns:: This builder for chaining.

setPageTokenBytes

public SearchRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)

 A page token received from a previous
 [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
 must match the call that provided the page token. Otherwise, an
 `INVALID_ARGUMENT`  error is returned.

string page_token = 5;

Parameters:: value - The bytes for pageToken to set.
Returns:: This builder for chaining.

getOffset

public int getOffset()

 A 0-indexed integer that specifies the current offset (that is, starting
 result location, amongst the
 [Document][google.cloud.discoveryengine.v1.Document]s deemed by the API as
 relevant) in search results. This field is only considered if
 [page_token][google.cloud.discoveryengine.v1.SearchRequest.page_token] is
 unset.

 If this field is negative, an  `INVALID_ARGUMENT`  is returned.

 A large offset may be capped to a reasonable threshold.

int32 offset = 6;

Specified by:: getOffset in interface SearchRequestOrBuilder
Returns:: The offset.

setOffset

public SearchRequest.Builder setOffset(int value)

 A 0-indexed integer that specifies the current offset (that is, starting
 result location, amongst the
 [Document][google.cloud.discoveryengine.v1.Document]s deemed by the API as
 relevant) in search results. This field is only considered if
 [page_token][google.cloud.discoveryengine.v1.SearchRequest.page_token] is
 unset.

 If this field is negative, an  `INVALID_ARGUMENT`  is returned.

 A large offset may be capped to a reasonable threshold.

int32 offset = 6;

Parameters:: value - The offset to set.
Returns:: This builder for chaining.

clearOffset

public SearchRequest.Builder clearOffset()

 A 0-indexed integer that specifies the current offset (that is, starting
 result location, amongst the
 [Document][google.cloud.discoveryengine.v1.Document]s deemed by the API as
 relevant) in search results. This field is only considered if
 [page_token][google.cloud.discoveryengine.v1.SearchRequest.page_token] is
 unset.

 If this field is negative, an  `INVALID_ARGUMENT`  is returned.

 A large offset may be capped to a reasonable threshold.

int32 offset = 6;

Returns:: This builder for chaining.

getOneBoxPageSize

public int getOneBoxPageSize()

 The maximum number of results to return for OneBox.
 This applies to each OneBox type individually.
 Default number is 10.

int32 one_box_page_size = 47;

Specified by:: getOneBoxPageSize in interface SearchRequestOrBuilder
Returns:: The oneBoxPageSize.

setOneBoxPageSize

public SearchRequest.Builder setOneBoxPageSize(int value)

 The maximum number of results to return for OneBox.
 This applies to each OneBox type individually.
 Default number is 10.

int32 one_box_page_size = 47;

Parameters:: value - The oneBoxPageSize to set.
Returns:: This builder for chaining.

clearOneBoxPageSize

public SearchRequest.Builder clearOneBoxPageSize()

 The maximum number of results to return for OneBox.
 This applies to each OneBox type individually.
 Default number is 10.

int32 one_box_page_size = 47;

Returns:: This builder for chaining.

getDataStoreSpecsList

public List<SearchRequest.DataStoreSpec> getDataStoreSpecsList()

 Specifications that define the specific
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched,
 along with configurations for those data stores. This is only considered
 for [Engine][google.cloud.discoveryengine.v1.Engine]s with multiple data
 stores. For engines with a single data store, the specs directly under
 [SearchRequest][google.cloud.discoveryengine.v1.SearchRequest] should be
 used.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 32;

Specified by:: getDataStoreSpecsList in interface SearchRequestOrBuilder

getDataStoreSpecsCount

public int getDataStoreSpecsCount()

 Specifications that define the specific
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched,
 along with configurations for those data stores. This is only considered
 for [Engine][google.cloud.discoveryengine.v1.Engine]s with multiple data
 stores. For engines with a single data store, the specs directly under
 [SearchRequest][google.cloud.discoveryengine.v1.SearchRequest] should be
 used.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 32;

Specified by:: getDataStoreSpecsCount in interface SearchRequestOrBuilder

getDataStoreSpecs

public SearchRequest.DataStoreSpec getDataStoreSpecs(int index)

 Specifications that define the specific
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched,
 along with configurations for those data stores. This is only considered
 for [Engine][google.cloud.discoveryengine.v1.Engine]s with multiple data
 stores. For engines with a single data store, the specs directly under
 [SearchRequest][google.cloud.discoveryengine.v1.SearchRequest] should be
 used.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 32;

Specified by:: getDataStoreSpecs in interface SearchRequestOrBuilder

setDataStoreSpecs

public SearchRequest.Builder setDataStoreSpecs(int index,
                                               SearchRequest.DataStoreSpec value)

 Specifications that define the specific
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched,
 along with configurations for those data stores. This is only considered
 for [Engine][google.cloud.discoveryengine.v1.Engine]s with multiple data
 stores. For engines with a single data store, the specs directly under
 [SearchRequest][google.cloud.discoveryengine.v1.SearchRequest] should be
 used.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 32;

setDataStoreSpecs

public SearchRequest.Builder setDataStoreSpecs(int index,
                                               SearchRequest.DataStoreSpec.Builder builderForValue)

 Specifications that define the specific
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched,
 along with configurations for those data stores. This is only considered
 for [Engine][google.cloud.discoveryengine.v1.Engine]s with multiple data
 stores. For engines with a single data store, the specs directly under
 [SearchRequest][google.cloud.discoveryengine.v1.SearchRequest] should be
 used.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 32;

addDataStoreSpecs

public SearchRequest.Builder addDataStoreSpecs(SearchRequest.DataStoreSpec value)

 Specifications that define the specific
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched,
 along with configurations for those data stores. This is only considered
 for [Engine][google.cloud.discoveryengine.v1.Engine]s with multiple data
 stores. For engines with a single data store, the specs directly under
 [SearchRequest][google.cloud.discoveryengine.v1.SearchRequest] should be
 used.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 32;

addDataStoreSpecs

public SearchRequest.Builder addDataStoreSpecs(int index,
                                               SearchRequest.DataStoreSpec value)

 Specifications that define the specific
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched,
 along with configurations for those data stores. This is only considered
 for [Engine][google.cloud.discoveryengine.v1.Engine]s with multiple data
 stores. For engines with a single data store, the specs directly under
 [SearchRequest][google.cloud.discoveryengine.v1.SearchRequest] should be
 used.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 32;

addDataStoreSpecs

public SearchRequest.Builder addDataStoreSpecs(SearchRequest.DataStoreSpec.Builder builderForValue)

 Specifications that define the specific
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched,
 along with configurations for those data stores. This is only considered
 for [Engine][google.cloud.discoveryengine.v1.Engine]s with multiple data
 stores. For engines with a single data store, the specs directly under
 [SearchRequest][google.cloud.discoveryengine.v1.SearchRequest] should be
 used.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 32;

addDataStoreSpecs

public SearchRequest.Builder addDataStoreSpecs(int index,
                                               SearchRequest.DataStoreSpec.Builder builderForValue)

 Specifications that define the specific
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched,
 along with configurations for those data stores. This is only considered
 for [Engine][google.cloud.discoveryengine.v1.Engine]s with multiple data
 stores. For engines with a single data store, the specs directly under
 [SearchRequest][google.cloud.discoveryengine.v1.SearchRequest] should be
 used.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 32;

addAllDataStoreSpecs

public SearchRequest.Builder addAllDataStoreSpecs(Iterable<? extends SearchRequest.DataStoreSpec> values)

 Specifications that define the specific
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched,
 along with configurations for those data stores. This is only considered
 for [Engine][google.cloud.discoveryengine.v1.Engine]s with multiple data
 stores. For engines with a single data store, the specs directly under
 [SearchRequest][google.cloud.discoveryengine.v1.SearchRequest] should be
 used.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 32;

clearDataStoreSpecs

public SearchRequest.Builder clearDataStoreSpecs()

 Specifications that define the specific
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched,
 along with configurations for those data stores. This is only considered
 for [Engine][google.cloud.discoveryengine.v1.Engine]s with multiple data
 stores. For engines with a single data store, the specs directly under
 [SearchRequest][google.cloud.discoveryengine.v1.SearchRequest] should be
 used.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 32;

removeDataStoreSpecs

public SearchRequest.Builder removeDataStoreSpecs(int index)

 Specifications that define the specific
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched,
 along with configurations for those data stores. This is only considered
 for [Engine][google.cloud.discoveryengine.v1.Engine]s with multiple data
 stores. For engines with a single data store, the specs directly under
 [SearchRequest][google.cloud.discoveryengine.v1.SearchRequest] should be
 used.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 32;

getDataStoreSpecsBuilder

public SearchRequest.DataStoreSpec.Builder getDataStoreSpecsBuilder(int index)

 Specifications that define the specific
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched,
 along with configurations for those data stores. This is only considered
 for [Engine][google.cloud.discoveryengine.v1.Engine]s with multiple data
 stores. For engines with a single data store, the specs directly under
 [SearchRequest][google.cloud.discoveryengine.v1.SearchRequest] should be
 used.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 32;

getDataStoreSpecsOrBuilder

public SearchRequest.DataStoreSpecOrBuilder getDataStoreSpecsOrBuilder(int index)

 Specifications that define the specific
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched,
 along with configurations for those data stores. This is only considered
 for [Engine][google.cloud.discoveryengine.v1.Engine]s with multiple data
 stores. For engines with a single data store, the specs directly under
 [SearchRequest][google.cloud.discoveryengine.v1.SearchRequest] should be
 used.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 32;

Specified by:: getDataStoreSpecsOrBuilder in interface SearchRequestOrBuilder

getDataStoreSpecsOrBuilderList

public List<? extends SearchRequest.DataStoreSpecOrBuilder> getDataStoreSpecsOrBuilderList()

 Specifications that define the specific
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched,
 along with configurations for those data stores. This is only considered
 for [Engine][google.cloud.discoveryengine.v1.Engine]s with multiple data
 stores. For engines with a single data store, the specs directly under
 [SearchRequest][google.cloud.discoveryengine.v1.SearchRequest] should be
 used.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 32;

Specified by:: getDataStoreSpecsOrBuilderList in interface SearchRequestOrBuilder

addDataStoreSpecsBuilder

public SearchRequest.DataStoreSpec.Builder addDataStoreSpecsBuilder()

 Specifications that define the specific
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched,
 along with configurations for those data stores. This is only considered
 for [Engine][google.cloud.discoveryengine.v1.Engine]s with multiple data
 stores. For engines with a single data store, the specs directly under
 [SearchRequest][google.cloud.discoveryengine.v1.SearchRequest] should be
 used.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 32;

addDataStoreSpecsBuilder

public SearchRequest.DataStoreSpec.Builder addDataStoreSpecsBuilder(int index)

 Specifications that define the specific
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched,
 along with configurations for those data stores. This is only considered
 for [Engine][google.cloud.discoveryengine.v1.Engine]s with multiple data
 stores. For engines with a single data store, the specs directly under
 [SearchRequest][google.cloud.discoveryengine.v1.SearchRequest] should be
 used.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 32;

getDataStoreSpecsBuilderList

public List<SearchRequest.DataStoreSpec.Builder> getDataStoreSpecsBuilderList()

 Specifications that define the specific
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to be searched,
 along with configurations for those data stores. This is only considered
 for [Engine][google.cloud.discoveryengine.v1.Engine]s with multiple data
 stores. For engines with a single data store, the specs directly under
 [SearchRequest][google.cloud.discoveryengine.v1.SearchRequest] should be
 used.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 32;

getFilter

public String getFilter()

 The filter syntax consists of an expression language for constructing a
 predicate from one or more fields of the documents being filtered. Filter
 expression is case-sensitive.

 If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.

 Filtering in Vertex AI Search is done by mapping the LHS filter key to a
 key property defined in the Vertex AI Search backend -- this mapping is
 defined by the customer in their schema. For example a media customer might
 have a field 'name' in their schema. In this case the filter would look
 like this: filter --> name:'ANY("king kong")'

 For more information about filtering including syntax and filter
 operators, see
 [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)

string filter = 7;

Specified by:: getFilter in interface SearchRequestOrBuilder
Returns:: The filter.

getFilterBytes

public com.google.protobuf.ByteString getFilterBytes()

 The filter syntax consists of an expression language for constructing a
 predicate from one or more fields of the documents being filtered. Filter
 expression is case-sensitive.

 If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.

 Filtering in Vertex AI Search is done by mapping the LHS filter key to a
 key property defined in the Vertex AI Search backend -- this mapping is
 defined by the customer in their schema. For example a media customer might
 have a field 'name' in their schema. In this case the filter would look
 like this: filter --> name:'ANY("king kong")'

 For more information about filtering including syntax and filter
 operators, see
 [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)

string filter = 7;

Specified by:: getFilterBytes in interface SearchRequestOrBuilder
Returns:: The bytes for filter.

setFilter

public SearchRequest.Builder setFilter(String value)

 The filter syntax consists of an expression language for constructing a
 predicate from one or more fields of the documents being filtered. Filter
 expression is case-sensitive.

 If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.

 Filtering in Vertex AI Search is done by mapping the LHS filter key to a
 key property defined in the Vertex AI Search backend -- this mapping is
 defined by the customer in their schema. For example a media customer might
 have a field 'name' in their schema. In this case the filter would look
 like this: filter --> name:'ANY("king kong")'

 For more information about filtering including syntax and filter
 operators, see
 [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)

string filter = 7;

Parameters:: value - The filter to set.
Returns:: This builder for chaining.

clearFilter

public SearchRequest.Builder clearFilter()

 The filter syntax consists of an expression language for constructing a
 predicate from one or more fields of the documents being filtered. Filter
 expression is case-sensitive.

 If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.

 Filtering in Vertex AI Search is done by mapping the LHS filter key to a
 key property defined in the Vertex AI Search backend -- this mapping is
 defined by the customer in their schema. For example a media customer might
 have a field 'name' in their schema. In this case the filter would look
 like this: filter --> name:'ANY("king kong")'

 For more information about filtering including syntax and filter
 operators, see
 [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)

string filter = 7;

Returns:: This builder for chaining.

setFilterBytes

public SearchRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)

 The filter syntax consists of an expression language for constructing a
 predicate from one or more fields of the documents being filtered. Filter
 expression is case-sensitive.

 If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.

 Filtering in Vertex AI Search is done by mapping the LHS filter key to a
 key property defined in the Vertex AI Search backend -- this mapping is
 defined by the customer in their schema. For example a media customer might
 have a field 'name' in their schema. In this case the filter would look
 like this: filter --> name:'ANY("king kong")'

 For more information about filtering including syntax and filter
 operators, see
 [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)

string filter = 7;

Parameters:: value - The bytes for filter to set.
Returns:: This builder for chaining.

getCanonicalFilter

public String getCanonicalFilter()

 The default filter that is applied when a user performs a search without
 checking any filters on the search page.

 The filter applied to every search request when quality improvement such as
 query expansion is needed. In the case a query does not have a sufficient
 amount of results this filter will be used to determine whether or not to
 enable the query expansion flow. The original filter will still be used for
 the query expanded search.
 This field is strongly recommended to achieve high search quality.

 For more information about filter syntax, see
 [SearchRequest.filter][google.cloud.discoveryengine.v1.SearchRequest.filter].

string canonical_filter = 29;

Specified by:: getCanonicalFilter in interface SearchRequestOrBuilder
Returns:: The canonicalFilter.

getCanonicalFilterBytes

public com.google.protobuf.ByteString getCanonicalFilterBytes()

 The default filter that is applied when a user performs a search without
 checking any filters on the search page.

 The filter applied to every search request when quality improvement such as
 query expansion is needed. In the case a query does not have a sufficient
 amount of results this filter will be used to determine whether or not to
 enable the query expansion flow. The original filter will still be used for
 the query expanded search.
 This field is strongly recommended to achieve high search quality.

 For more information about filter syntax, see
 [SearchRequest.filter][google.cloud.discoveryengine.v1.SearchRequest.filter].

string canonical_filter = 29;

Specified by:: getCanonicalFilterBytes in interface SearchRequestOrBuilder
Returns:: The bytes for canonicalFilter.

setCanonicalFilter

public SearchRequest.Builder setCanonicalFilter(String value)

 The default filter that is applied when a user performs a search without
 checking any filters on the search page.

 The filter applied to every search request when quality improvement such as
 query expansion is needed. In the case a query does not have a sufficient
 amount of results this filter will be used to determine whether or not to
 enable the query expansion flow. The original filter will still be used for
 the query expanded search.
 This field is strongly recommended to achieve high search quality.

 For more information about filter syntax, see
 [SearchRequest.filter][google.cloud.discoveryengine.v1.SearchRequest.filter].

string canonical_filter = 29;

Parameters:: value - The canonicalFilter to set.
Returns:: This builder for chaining.

clearCanonicalFilter

public SearchRequest.Builder clearCanonicalFilter()

 The default filter that is applied when a user performs a search without
 checking any filters on the search page.

 The filter applied to every search request when quality improvement such as
 query expansion is needed. In the case a query does not have a sufficient
 amount of results this filter will be used to determine whether or not to
 enable the query expansion flow. The original filter will still be used for
 the query expanded search.
 This field is strongly recommended to achieve high search quality.

 For more information about filter syntax, see
 [SearchRequest.filter][google.cloud.discoveryengine.v1.SearchRequest.filter].

string canonical_filter = 29;

Returns:: This builder for chaining.

setCanonicalFilterBytes

public SearchRequest.Builder setCanonicalFilterBytes(com.google.protobuf.ByteString value)

 The default filter that is applied when a user performs a search without
 checking any filters on the search page.

 The filter applied to every search request when quality improvement such as
 query expansion is needed. In the case a query does not have a sufficient
 amount of results this filter will be used to determine whether or not to
 enable the query expansion flow. The original filter will still be used for
 the query expanded search.
 This field is strongly recommended to achieve high search quality.

 For more information about filter syntax, see
 [SearchRequest.filter][google.cloud.discoveryengine.v1.SearchRequest.filter].

string canonical_filter = 29;

Parameters:: value - The bytes for canonicalFilter to set.
Returns:: This builder for chaining.

getOrderBy

public String getOrderBy()

 The order in which documents are returned. Documents can be ordered by
 a field in an [Document][google.cloud.discoveryengine.v1.Document] object.
 Leave it unset if ordered by relevance. `order_by` expression is
 case-sensitive.

 For more information on ordering the website search results, see
 [Order web search
 results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
 For more information on ordering the healthcare search results, see
 [Order healthcare search
 results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
 If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.

string order_by = 8;

Specified by:: getOrderBy in interface SearchRequestOrBuilder
Returns:: The orderBy.

getOrderByBytes

public com.google.protobuf.ByteString getOrderByBytes()

 The order in which documents are returned. Documents can be ordered by
 a field in an [Document][google.cloud.discoveryengine.v1.Document] object.
 Leave it unset if ordered by relevance. `order_by` expression is
 case-sensitive.

 For more information on ordering the website search results, see
 [Order web search
 results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
 For more information on ordering the healthcare search results, see
 [Order healthcare search
 results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
 If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.

string order_by = 8;

Specified by:: getOrderByBytes in interface SearchRequestOrBuilder
Returns:: The bytes for orderBy.

setOrderBy

public SearchRequest.Builder setOrderBy(String value)

 The order in which documents are returned. Documents can be ordered by
 a field in an [Document][google.cloud.discoveryengine.v1.Document] object.
 Leave it unset if ordered by relevance. `order_by` expression is
 case-sensitive.

 For more information on ordering the website search results, see
 [Order web search
 results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
 For more information on ordering the healthcare search results, see
 [Order healthcare search
 results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
 If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.

string order_by = 8;

Parameters:: value - The orderBy to set.
Returns:: This builder for chaining.

clearOrderBy

public SearchRequest.Builder clearOrderBy()

 The order in which documents are returned. Documents can be ordered by
 a field in an [Document][google.cloud.discoveryengine.v1.Document] object.
 Leave it unset if ordered by relevance. `order_by` expression is
 case-sensitive.

 For more information on ordering the website search results, see
 [Order web search
 results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
 For more information on ordering the healthcare search results, see
 [Order healthcare search
 results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
 If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.

string order_by = 8;

Returns:: This builder for chaining.

setOrderByBytes

public SearchRequest.Builder setOrderByBytes(com.google.protobuf.ByteString value)

 The order in which documents are returned. Documents can be ordered by
 a field in an [Document][google.cloud.discoveryengine.v1.Document] object.
 Leave it unset if ordered by relevance. `order_by` expression is
 case-sensitive.

 For more information on ordering the website search results, see
 [Order web search
 results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
 For more information on ordering the healthcare search results, see
 [Order healthcare search
 results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
 If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.

string order_by = 8;

Parameters:: value - The bytes for orderBy to set.
Returns:: This builder for chaining.

hasUserInfo

public boolean hasUserInfo()

 Information about the end user.
 Highly recommended for analytics and personalization.
 [UserInfo.user_agent][google.cloud.discoveryengine.v1.UserInfo.user_agent]
 is used to deduce `device_type` for analytics.

.google.cloud.discoveryengine.v1.UserInfo user_info = 21;

Specified by:: hasUserInfo in interface SearchRequestOrBuilder
Returns:: Whether the userInfo field is set.

getUserInfo

public UserInfo getUserInfo()

 Information about the end user.
 Highly recommended for analytics and personalization.
 [UserInfo.user_agent][google.cloud.discoveryengine.v1.UserInfo.user_agent]
 is used to deduce `device_type` for analytics.

.google.cloud.discoveryengine.v1.UserInfo user_info = 21;

Specified by:: getUserInfo in interface SearchRequestOrBuilder
Returns:: The userInfo.

setUserInfo

public SearchRequest.Builder setUserInfo(UserInfo value)

 Information about the end user.
 Highly recommended for analytics and personalization.
 [UserInfo.user_agent][google.cloud.discoveryengine.v1.UserInfo.user_agent]
 is used to deduce `device_type` for analytics.

.google.cloud.discoveryengine.v1.UserInfo user_info = 21;

setUserInfo

public SearchRequest.Builder setUserInfo(UserInfo.Builder builderForValue)

 Information about the end user.
 Highly recommended for analytics and personalization.
 [UserInfo.user_agent][google.cloud.discoveryengine.v1.UserInfo.user_agent]
 is used to deduce `device_type` for analytics.

.google.cloud.discoveryengine.v1.UserInfo user_info = 21;

mergeUserInfo

public SearchRequest.Builder mergeUserInfo(UserInfo value)

 Information about the end user.
 Highly recommended for analytics and personalization.
 [UserInfo.user_agent][google.cloud.discoveryengine.v1.UserInfo.user_agent]
 is used to deduce `device_type` for analytics.

.google.cloud.discoveryengine.v1.UserInfo user_info = 21;

clearUserInfo

public SearchRequest.Builder clearUserInfo()

 Information about the end user.
 Highly recommended for analytics and personalization.
 [UserInfo.user_agent][google.cloud.discoveryengine.v1.UserInfo.user_agent]
 is used to deduce `device_type` for analytics.

.google.cloud.discoveryengine.v1.UserInfo user_info = 21;

getUserInfoBuilder

public UserInfo.Builder getUserInfoBuilder()

 Information about the end user.
 Highly recommended for analytics and personalization.
 [UserInfo.user_agent][google.cloud.discoveryengine.v1.UserInfo.user_agent]
 is used to deduce `device_type` for analytics.

.google.cloud.discoveryengine.v1.UserInfo user_info = 21;

getUserInfoOrBuilder

public UserInfoOrBuilder getUserInfoOrBuilder()

 Information about the end user.
 Highly recommended for analytics and personalization.
 [UserInfo.user_agent][google.cloud.discoveryengine.v1.UserInfo.user_agent]
 is used to deduce `device_type` for analytics.

.google.cloud.discoveryengine.v1.UserInfo user_info = 21;

Specified by:: getUserInfoOrBuilder in interface SearchRequestOrBuilder

getLanguageCode

public String getLanguageCode()

 The BCP-47 language code, such as "en-US" or "sr-Latn". For more
 information, see [Standard
 fields](https://cloud.google.com/apis/design/standard_fields). This field
 helps to better interpret the query. If a value isn't specified, the query
 language code is automatically detected, which may not be accurate.

string language_code = 35;

Specified by:: getLanguageCode in interface SearchRequestOrBuilder
Returns:: The languageCode.

getLanguageCodeBytes

public com.google.protobuf.ByteString getLanguageCodeBytes()

 The BCP-47 language code, such as "en-US" or "sr-Latn". For more
 information, see [Standard
 fields](https://cloud.google.com/apis/design/standard_fields). This field
 helps to better interpret the query. If a value isn't specified, the query
 language code is automatically detected, which may not be accurate.

string language_code = 35;

Specified by:: getLanguageCodeBytes in interface SearchRequestOrBuilder
Returns:: The bytes for languageCode.

setLanguageCode

public SearchRequest.Builder setLanguageCode(String value)

 The BCP-47 language code, such as "en-US" or "sr-Latn". For more
 information, see [Standard
 fields](https://cloud.google.com/apis/design/standard_fields). This field
 helps to better interpret the query. If a value isn't specified, the query
 language code is automatically detected, which may not be accurate.

string language_code = 35;

Parameters:: value - The languageCode to set.
Returns:: This builder for chaining.

clearLanguageCode

public SearchRequest.Builder clearLanguageCode()

 The BCP-47 language code, such as "en-US" or "sr-Latn". For more
 information, see [Standard
 fields](https://cloud.google.com/apis/design/standard_fields). This field
 helps to better interpret the query. If a value isn't specified, the query
 language code is automatically detected, which may not be accurate.

string language_code = 35;

Returns:: This builder for chaining.

setLanguageCodeBytes

public SearchRequest.Builder setLanguageCodeBytes(com.google.protobuf.ByteString value)

 The BCP-47 language code, such as "en-US" or "sr-Latn". For more
 information, see [Standard
 fields](https://cloud.google.com/apis/design/standard_fields). This field
 helps to better interpret the query. If a value isn't specified, the query
 language code is automatically detected, which may not be accurate.

string language_code = 35;

Parameters:: value - The bytes for languageCode to set.
Returns:: This builder for chaining.

getFacetSpecsList

public List<SearchRequest.FacetSpec> getFacetSpecsList()

 Facet specifications for faceted search. If empty, no facets are returned.

 A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
 error is returned.

repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;

Specified by:: getFacetSpecsList in interface SearchRequestOrBuilder

getFacetSpecsCount

public int getFacetSpecsCount()

 Facet specifications for faceted search. If empty, no facets are returned.

 A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
 error is returned.

repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;

Specified by:: getFacetSpecsCount in interface SearchRequestOrBuilder

getFacetSpecs

public SearchRequest.FacetSpec getFacetSpecs(int index)

 Facet specifications for faceted search. If empty, no facets are returned.

 A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
 error is returned.

repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;

Specified by:: getFacetSpecs in interface SearchRequestOrBuilder

setFacetSpecs

public SearchRequest.Builder setFacetSpecs(int index,
                                           SearchRequest.FacetSpec value)

 Facet specifications for faceted search. If empty, no facets are returned.

 A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
 error is returned.

repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;

setFacetSpecs

public SearchRequest.Builder setFacetSpecs(int index,
                                           SearchRequest.FacetSpec.Builder builderForValue)

 Facet specifications for faceted search. If empty, no facets are returned.

 A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
 error is returned.

repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;

addFacetSpecs

public SearchRequest.Builder addFacetSpecs(SearchRequest.FacetSpec value)

 Facet specifications for faceted search. If empty, no facets are returned.

 A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
 error is returned.

repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;

addFacetSpecs

public SearchRequest.Builder addFacetSpecs(int index,
                                           SearchRequest.FacetSpec value)

 Facet specifications for faceted search. If empty, no facets are returned.

 A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
 error is returned.

repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;

addFacetSpecs

public SearchRequest.Builder addFacetSpecs(SearchRequest.FacetSpec.Builder builderForValue)

 Facet specifications for faceted search. If empty, no facets are returned.

 A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
 error is returned.

repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;

addFacetSpecs

public SearchRequest.Builder addFacetSpecs(int index,
                                           SearchRequest.FacetSpec.Builder builderForValue)

 Facet specifications for faceted search. If empty, no facets are returned.

 A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
 error is returned.

repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;

addAllFacetSpecs

public SearchRequest.Builder addAllFacetSpecs(Iterable<? extends SearchRequest.FacetSpec> values)

 Facet specifications for faceted search. If empty, no facets are returned.

 A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
 error is returned.

repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;

clearFacetSpecs

public SearchRequest.Builder clearFacetSpecs()

 Facet specifications for faceted search. If empty, no facets are returned.

 A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
 error is returned.

repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;

removeFacetSpecs

public SearchRequest.Builder removeFacetSpecs(int index)

 Facet specifications for faceted search. If empty, no facets are returned.

 A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
 error is returned.

repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;

getFacetSpecsBuilder

public SearchRequest.FacetSpec.Builder getFacetSpecsBuilder(int index)

 Facet specifications for faceted search. If empty, no facets are returned.

 A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
 error is returned.

repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;

getFacetSpecsOrBuilder

public SearchRequest.FacetSpecOrBuilder getFacetSpecsOrBuilder(int index)

 Facet specifications for faceted search. If empty, no facets are returned.

 A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
 error is returned.

repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;

Specified by:: getFacetSpecsOrBuilder in interface SearchRequestOrBuilder

getFacetSpecsOrBuilderList

public List<? extends SearchRequest.FacetSpecOrBuilder> getFacetSpecsOrBuilderList()

 Facet specifications for faceted search. If empty, no facets are returned.

 A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
 error is returned.

repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;

Specified by:: getFacetSpecsOrBuilderList in interface SearchRequestOrBuilder

addFacetSpecsBuilder

public SearchRequest.FacetSpec.Builder addFacetSpecsBuilder()

 Facet specifications for faceted search. If empty, no facets are returned.

 A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
 error is returned.

repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;

addFacetSpecsBuilder

public SearchRequest.FacetSpec.Builder addFacetSpecsBuilder(int index)

 Facet specifications for faceted search. If empty, no facets are returned.

 A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
 error is returned.

repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;

getFacetSpecsBuilderList

public List<SearchRequest.FacetSpec.Builder> getFacetSpecsBuilderList()

 Facet specifications for faceted search. If empty, no facets are returned.

 A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
 error is returned.

repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;

hasBoostSpec

public boolean hasBoostSpec()

 Boost specification to boost certain documents.
 For more information on boosting, see
 [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)

.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec boost_spec = 10;

Specified by:: hasBoostSpec in interface SearchRequestOrBuilder
Returns:: Whether the boostSpec field is set.

getBoostSpec

public SearchRequest.BoostSpec getBoostSpec()

 Boost specification to boost certain documents.
 For more information on boosting, see
 [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)

.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec boost_spec = 10;

Specified by:: getBoostSpec in interface SearchRequestOrBuilder
Returns:: The boostSpec.

setBoostSpec

public SearchRequest.Builder setBoostSpec(SearchRequest.BoostSpec value)

 Boost specification to boost certain documents.
 For more information on boosting, see
 [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)

.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec boost_spec = 10;

setBoostSpec

public SearchRequest.Builder setBoostSpec(SearchRequest.BoostSpec.Builder builderForValue)

 Boost specification to boost certain documents.
 For more information on boosting, see
 [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)

.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec boost_spec = 10;

mergeBoostSpec

public SearchRequest.Builder mergeBoostSpec(SearchRequest.BoostSpec value)

 Boost specification to boost certain documents.
 For more information on boosting, see
 [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)

.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec boost_spec = 10;

clearBoostSpec

public SearchRequest.Builder clearBoostSpec()

 Boost specification to boost certain documents.
 For more information on boosting, see
 [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)

.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec boost_spec = 10;

getBoostSpecBuilder

public SearchRequest.BoostSpec.Builder getBoostSpecBuilder()

 Boost specification to boost certain documents.
 For more information on boosting, see
 [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)

.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec boost_spec = 10;

getBoostSpecOrBuilder

public SearchRequest.BoostSpecOrBuilder getBoostSpecOrBuilder()

 Boost specification to boost certain documents.
 For more information on boosting, see
 [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)

.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec boost_spec = 10;

Specified by:: getBoostSpecOrBuilder in interface SearchRequestOrBuilder

getParamsCount

public int getParamsCount()

Description copied from interface: SearchRequestOrBuilder

 Additional search parameters.

 For public website search only, supported values are:

 * `user_country_code`: string. Default empty. If set to non-empty, results
 are restricted or boosted based on the location provided.
 For example, `user_country_code: "au"`

 For available codes see [Country
 Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)

 * `search_type`: double. Default empty. Enables non-webpage searching
 depending on the value. The only valid non-default value is 1,
 which enables image searching.
 For example, `search_type: 1`

map<string, .google.protobuf.Value> params = 11;

Specified by:: getParamsCount in interface SearchRequestOrBuilder

containsParams

public boolean containsParams(String key)

 Additional search parameters.

 For public website search only, supported values are:

 * `user_country_code`: string. Default empty. If set to non-empty, results
 are restricted or boosted based on the location provided.
 For example, `user_country_code: "au"`

 For available codes see [Country
 Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)

 * `search_type`: double. Default empty. Enables non-webpage searching
 depending on the value. The only valid non-default value is 1,
 which enables image searching.
 For example, `search_type: 1`

map<string, .google.protobuf.Value> params = 11;

Specified by:: containsParams in interface SearchRequestOrBuilder

getParams
```
@Deprecated
public Map<String,com.google.protobuf.Value> getParams()
```
Deprecated.

Use getParamsMap() instead.

Specified by:

getParams in interface SearchRequestOrBuilder

getParamsMap

public Map<String,com.google.protobuf.Value> getParamsMap()

 Additional search parameters.

 For public website search only, supported values are:

 * `user_country_code`: string. Default empty. If set to non-empty, results
 are restricted or boosted based on the location provided.
 For example, `user_country_code: "au"`

 For available codes see [Country
 Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)

 * `search_type`: double. Default empty. Enables non-webpage searching
 depending on the value. The only valid non-default value is 1,
 which enables image searching.
 For example, `search_type: 1`

map<string, .google.protobuf.Value> params = 11;

Specified by:: getParamsMap in interface SearchRequestOrBuilder

getParamsOrDefault

public com.google.protobuf.Value getParamsOrDefault(String key,
                                                    com.google.protobuf.Value defaultValue)

 Additional search parameters.

 For public website search only, supported values are:

 * `user_country_code`: string. Default empty. If set to non-empty, results
 are restricted or boosted based on the location provided.
 For example, `user_country_code: "au"`

 For available codes see [Country
 Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)

 * `search_type`: double. Default empty. Enables non-webpage searching
 depending on the value. The only valid non-default value is 1,
 which enables image searching.
 For example, `search_type: 1`

map<string, .google.protobuf.Value> params = 11;

Specified by:: getParamsOrDefault in interface SearchRequestOrBuilder

getParamsOrThrow

public com.google.protobuf.Value getParamsOrThrow(String key)

 Additional search parameters.

 For public website search only, supported values are:

 * `user_country_code`: string. Default empty. If set to non-empty, results
 are restricted or boosted based on the location provided.
 For example, `user_country_code: "au"`

 For available codes see [Country
 Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)

 * `search_type`: double. Default empty. Enables non-webpage searching
 depending on the value. The only valid non-default value is 1,
 which enables image searching.
 For example, `search_type: 1`

map<string, .google.protobuf.Value> params = 11;

Specified by:: getParamsOrThrow in interface SearchRequestOrBuilder

clearParams

public SearchRequest.Builder clearParams()

removeParams

public SearchRequest.Builder removeParams(String key)

 Additional search parameters.

 For public website search only, supported values are:

 * `user_country_code`: string. Default empty. If set to non-empty, results
 are restricted or boosted based on the location provided.
 For example, `user_country_code: "au"`

 For available codes see [Country
 Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)

 * `search_type`: double. Default empty. Enables non-webpage searching
 depending on the value. The only valid non-default value is 1,
 which enables image searching.
 For example, `search_type: 1`

map<string, .google.protobuf.Value> params = 11;

getMutableParams

@Deprecated
public Map<String,com.google.protobuf.Value> getMutableParams()

Deprecated.

Use alternate mutation accessors instead.

putParams

public SearchRequest.Builder putParams(String key,
                                       com.google.protobuf.Value value)

 Additional search parameters.

 For public website search only, supported values are:

 * `user_country_code`: string. Default empty. If set to non-empty, results
 are restricted or boosted based on the location provided.
 For example, `user_country_code: "au"`

 For available codes see [Country
 Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)

 * `search_type`: double. Default empty. Enables non-webpage searching
 depending on the value. The only valid non-default value is 1,
 which enables image searching.
 For example, `search_type: 1`

map<string, .google.protobuf.Value> params = 11;

putAllParams

public SearchRequest.Builder putAllParams(Map<String,com.google.protobuf.Value> values)

 Additional search parameters.

 For public website search only, supported values are:

 * `user_country_code`: string. Default empty. If set to non-empty, results
 are restricted or boosted based on the location provided.
 For example, `user_country_code: "au"`

 For available codes see [Country
 Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)

 * `search_type`: double. Default empty. Enables non-webpage searching
 depending on the value. The only valid non-default value is 1,
 which enables image searching.
 For example, `search_type: 1`

map<string, .google.protobuf.Value> params = 11;

putParamsBuilderIfAbsent

public com.google.protobuf.Value.Builder putParamsBuilderIfAbsent(String key)

 Additional search parameters.

 For public website search only, supported values are:

 * `user_country_code`: string. Default empty. If set to non-empty, results
 are restricted or boosted based on the location provided.
 For example, `user_country_code: "au"`

 For available codes see [Country
 Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)

 * `search_type`: double. Default empty. Enables non-webpage searching
 depending on the value. The only valid non-default value is 1,
 which enables image searching.
 For example, `search_type: 1`

map<string, .google.protobuf.Value> params = 11;

hasQueryExpansionSpec
```
public boolean hasQueryExpansionSpec()
```
```
 The query expansion specification that specifies the conditions under which
 query expansion occurs.
 
```
.google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;
Specified by:

hasQueryExpansionSpec in interface SearchRequestOrBuilder

Returns:

Whether the queryExpansionSpec field is set.

getQueryExpansionSpec
```
public SearchRequest.QueryExpansionSpec getQueryExpansionSpec()
```
```
 The query expansion specification that specifies the conditions under which
 query expansion occurs.
 
```
.google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;
Specified by:

getQueryExpansionSpec in interface SearchRequestOrBuilder

Returns:

The queryExpansionSpec.

setQueryExpansionSpec

public SearchRequest.Builder setQueryExpansionSpec(SearchRequest.QueryExpansionSpec value)

 The query expansion specification that specifies the conditions under which
 query expansion occurs.


 .google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;

setQueryExpansionSpec

public SearchRequest.Builder setQueryExpansionSpec(SearchRequest.QueryExpansionSpec.Builder builderForValue)

 The query expansion specification that specifies the conditions under which
 query expansion occurs.


 .google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;

mergeQueryExpansionSpec

public SearchRequest.Builder mergeQueryExpansionSpec(SearchRequest.QueryExpansionSpec value)

 The query expansion specification that specifies the conditions under which
 query expansion occurs.


 .google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;

clearQueryExpansionSpec

public SearchRequest.Builder clearQueryExpansionSpec()

 The query expansion specification that specifies the conditions under which
 query expansion occurs.


 .google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;

getQueryExpansionSpecBuilder

public SearchRequest.QueryExpansionSpec.Builder getQueryExpansionSpecBuilder()

 The query expansion specification that specifies the conditions under which
 query expansion occurs.


 .google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;

getQueryExpansionSpecOrBuilder
```
public SearchRequest.QueryExpansionSpecOrBuilder getQueryExpansionSpecOrBuilder()
```
```
 The query expansion specification that specifies the conditions under which
 query expansion occurs.
 
```
.google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;
Specified by:

getQueryExpansionSpecOrBuilder in interface SearchRequestOrBuilder

hasSpellCorrectionSpec
```
public boolean hasSpellCorrectionSpec()
```
```
 The spell correction specification that specifies the mode under
 which spell correction takes effect.
 
```
.google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;
Specified by:

hasSpellCorrectionSpec in interface SearchRequestOrBuilder

Returns:

Whether the spellCorrectionSpec field is set.

getSpellCorrectionSpec
```
public SearchRequest.SpellCorrectionSpec getSpellCorrectionSpec()
```
```
 The spell correction specification that specifies the mode under
 which spell correction takes effect.
 
```
.google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;
Specified by:

getSpellCorrectionSpec in interface SearchRequestOrBuilder

Returns:

The spellCorrectionSpec.

setSpellCorrectionSpec

public SearchRequest.Builder setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec value)

 The spell correction specification that specifies the mode under
 which spell correction takes effect.


 .google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;

setSpellCorrectionSpec

public SearchRequest.Builder setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec.Builder builderForValue)

 The spell correction specification that specifies the mode under
 which spell correction takes effect.


 .google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;

mergeSpellCorrectionSpec

public SearchRequest.Builder mergeSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec value)

 The spell correction specification that specifies the mode under
 which spell correction takes effect.


 .google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;

clearSpellCorrectionSpec

public SearchRequest.Builder clearSpellCorrectionSpec()

 The spell correction specification that specifies the mode under
 which spell correction takes effect.


 .google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;

getSpellCorrectionSpecBuilder

public SearchRequest.SpellCorrectionSpec.Builder getSpellCorrectionSpecBuilder()

 The spell correction specification that specifies the mode under
 which spell correction takes effect.


 .google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;

getSpellCorrectionSpecOrBuilder
```
public SearchRequest.SpellCorrectionSpecOrBuilder getSpellCorrectionSpecOrBuilder()
```
```
 The spell correction specification that specifies the mode under
 which spell correction takes effect.
 
```
.google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;
Specified by:

getSpellCorrectionSpecOrBuilder in interface SearchRequestOrBuilder

getUserPseudoId

public String getUserPseudoId()

 Optional. A unique identifier for tracking visitors. For example, this
 could be implemented with an HTTP cookie, which should be able to uniquely
 identify a visitor on a single device. This unique identifier should not
 change if the visitor logs in or out of the website.

 This field should NOT have a fixed value such as `unknown_visitor`.

 This should be the same identifier as
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id]
 and
 [CompleteQueryRequest.user_pseudo_id][google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id]

 The field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an  `INVALID_ARGUMENT`  error is returned.

string user_pseudo_id = 15 [(.google.api.field_behavior) = OPTIONAL];

Specified by:: getUserPseudoId in interface SearchRequestOrBuilder
Returns:: The userPseudoId.

getUserPseudoIdBytes

public com.google.protobuf.ByteString getUserPseudoIdBytes()

 Optional. A unique identifier for tracking visitors. For example, this
 could be implemented with an HTTP cookie, which should be able to uniquely
 identify a visitor on a single device. This unique identifier should not
 change if the visitor logs in or out of the website.

 This field should NOT have a fixed value such as `unknown_visitor`.

 This should be the same identifier as
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id]
 and
 [CompleteQueryRequest.user_pseudo_id][google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id]

 The field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an  `INVALID_ARGUMENT`  error is returned.

string user_pseudo_id = 15 [(.google.api.field_behavior) = OPTIONAL];

Specified by:: getUserPseudoIdBytes in interface SearchRequestOrBuilder
Returns:: The bytes for userPseudoId.

setUserPseudoId

public SearchRequest.Builder setUserPseudoId(String value)

 Optional. A unique identifier for tracking visitors. For example, this
 could be implemented with an HTTP cookie, which should be able to uniquely
 identify a visitor on a single device. This unique identifier should not
 change if the visitor logs in or out of the website.

 This field should NOT have a fixed value such as `unknown_visitor`.

 This should be the same identifier as
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id]
 and
 [CompleteQueryRequest.user_pseudo_id][google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id]

 The field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an  `INVALID_ARGUMENT`  error is returned.

string user_pseudo_id = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameters:: value - The userPseudoId to set.
Returns:: This builder for chaining.

clearUserPseudoId

public SearchRequest.Builder clearUserPseudoId()

 Optional. A unique identifier for tracking visitors. For example, this
 could be implemented with an HTTP cookie, which should be able to uniquely
 identify a visitor on a single device. This unique identifier should not
 change if the visitor logs in or out of the website.

 This field should NOT have a fixed value such as `unknown_visitor`.

 This should be the same identifier as
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id]
 and
 [CompleteQueryRequest.user_pseudo_id][google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id]

 The field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an  `INVALID_ARGUMENT`  error is returned.

string user_pseudo_id = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns:: This builder for chaining.

setUserPseudoIdBytes

public SearchRequest.Builder setUserPseudoIdBytes(com.google.protobuf.ByteString value)

 Optional. A unique identifier for tracking visitors. For example, this
 could be implemented with an HTTP cookie, which should be able to uniquely
 identify a visitor on a single device. This unique identifier should not
 change if the visitor logs in or out of the website.

 This field should NOT have a fixed value such as `unknown_visitor`.

 This should be the same identifier as
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id]
 and
 [CompleteQueryRequest.user_pseudo_id][google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id]

 The field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an  `INVALID_ARGUMENT`  error is returned.

string user_pseudo_id = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameters:: value - The bytes for userPseudoId to set.
Returns:: This builder for chaining.

hasContentSearchSpec
```
public boolean hasContentSearchSpec()
```
```
 A specification for configuring the behavior of content search.
 
```
.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec content_search_spec = 24;
Specified by:

hasContentSearchSpec in interface SearchRequestOrBuilder

Returns:

Whether the contentSearchSpec field is set.

getContentSearchSpec
```
public SearchRequest.ContentSearchSpec getContentSearchSpec()
```
```
 A specification for configuring the behavior of content search.
 
```
.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec content_search_spec = 24;
Specified by:

getContentSearchSpec in interface SearchRequestOrBuilder

Returns:

The contentSearchSpec.

setContentSearchSpec

public SearchRequest.Builder setContentSearchSpec(SearchRequest.ContentSearchSpec value)

 A specification for configuring the behavior of content search.


 .google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec content_search_spec = 24;

setContentSearchSpec

public SearchRequest.Builder setContentSearchSpec(SearchRequest.ContentSearchSpec.Builder builderForValue)

 A specification for configuring the behavior of content search.


 .google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec content_search_spec = 24;

mergeContentSearchSpec

public SearchRequest.Builder mergeContentSearchSpec(SearchRequest.ContentSearchSpec value)

 A specification for configuring the behavior of content search.


 .google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec content_search_spec = 24;

clearContentSearchSpec

public SearchRequest.Builder clearContentSearchSpec()

 A specification for configuring the behavior of content search.


 .google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec content_search_spec = 24;

getContentSearchSpecBuilder

public SearchRequest.ContentSearchSpec.Builder getContentSearchSpecBuilder()

 A specification for configuring the behavior of content search.


 .google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec content_search_spec = 24;

getContentSearchSpecOrBuilder
```
public SearchRequest.ContentSearchSpecOrBuilder getContentSearchSpecOrBuilder()
```
```
 A specification for configuring the behavior of content search.
 
```
.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec content_search_spec = 24;
Specified by:

getContentSearchSpecOrBuilder in interface SearchRequestOrBuilder

getRankingExpression

public String getRankingExpression()

Optional. The ranking expression controls the customized ranking on
retrieval documents. This overrides
[ServingConfig.ranking_expression][google.cloud.discoveryengine.v1.ServingConfig.ranking_expression].
The syntax and supported features depend on the
`ranking_expression_backend` value. If `ranking_expression_backend` is not
provided, it defaults to `RANK_BY_EMBEDDING`.

If
[ranking_expression_backend][google.cloud.discoveryengine.v1.SearchRequest.ranking_expression_backend]
is not provided or set to `RANK_BY_EMBEDDING`, it should be a single
function or multiple functions that are joined by "+".

* ranking_expression = function, { " + ", function };

Supported functions:

* double * relevance_score
* double * dotProduct(embedding_field_path)

Function variables:

* `relevance_score`: pre-defined keywords, used for measure relevance
between query and document.
* `embedding_field_path`: the document embedding field
used with query embedding vector.
* `dotProduct`: embedding function between `embedding_field_path` and
query embedding vector.

Example ranking expression:

If document has an embedding field doc_embedding, the ranking expression
could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.

If
[ranking_expression_backend][google.cloud.discoveryengine.v1.SearchRequest.ranking_expression_backend]
is set to `RANK_BY_FORMULA`, the following expression types (and
combinations of those chained using + or
* operators) are supported:

* `double`
* `signal`
* `log(signal)`
* `exp(signal)`
* `rr(signal, double > 0)` -- reciprocal rank transformation with second
argument being a denominator constant.
* `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise.
* `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns
signal2 | double, else returns signal1.

Here are a few examples of ranking formulas that use the supported
ranking expression types:

- `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)`
-- mostly rank by the logarithm of `keyword_similarity_score` with slight
`semantic_smilarity_score` adjustment.
- `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 *
is_nan(keyword_similarity_score)` -- rank by the exponent of
`semantic_similarity_score` filling the value with 0 if it's NaN, also
add constant 0.3 adjustment to the final score if
`semantic_similarity_score` is NaN.
- `0.2 * rr(semantic_similarity_score, 16) + 0.8 *
rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank
of `keyword_similarity_score` with slight adjustment of reciprocal rank
of `semantic_smilarity_score`.

The following signals are supported:

* `semantic_similarity_score`: semantic similarity adjustment that is
calculated using the embeddings generated by a proprietary Google model.
This score determines how semantically similar a search query is to a
document.
* `keyword_similarity_score`: keyword match adjustment uses the Best
Match 25 (BM25) ranking function. This score is calculated using a
probabilistic model to estimate the probability that a document is
relevant to a given query.
* `relevance_score`: semantic relevance adjustment that uses a
proprietary Google model to determine the meaning and intent behind a
user's query in context with the content in the documents.
* `pctr_rank`: predicted conversion rate adjustment as a rank use
predicted Click-through rate (pCTR) to gauge the relevance and
attractiveness of a search result from a user's perspective. A higher
pCTR suggests that the result is more likely to satisfy the user's query
and intent, making it a valuable signal for ranking.
* `freshness_rank`: freshness adjustment as a rank
* `document_age`: The time in hours elapsed since the document was last
updated, a floating-point number (e.g., 0.25 means 15 minutes).
* `topicality_rank`: topicality adjustment as a rank. Uses proprietary
Google model to determine the keyword-based overlap between the query and
the document.
* `base_rank`: the default rank of the result

string ranking_expression = 26 [(.google.api.field_behavior) = OPTIONAL];

Specified by:: getRankingExpression in interface SearchRequestOrBuilder
Returns:: The rankingExpression.

getRankingExpressionBytes

public com.google.protobuf.ByteString getRankingExpressionBytes()

* ranking_expression = function, { " + ", function };

Supported functions:

* double * relevance_score
* double * dotProduct(embedding_field_path)

Function variables:

Example ranking expression:

If document has an embedding field doc_embedding, the ranking expression
could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.

Here are a few examples of ranking formulas that use the supported
ranking expression types:

The following signals are supported:

string ranking_expression = 26 [(.google.api.field_behavior) = OPTIONAL];

Specified by:: getRankingExpressionBytes in interface SearchRequestOrBuilder
Returns:: The bytes for rankingExpression.

setRankingExpression

public SearchRequest.Builder setRankingExpression(String value)

* ranking_expression = function, { " + ", function };

Supported functions:

* double * relevance_score
* double * dotProduct(embedding_field_path)

Function variables:

Example ranking expression:

If document has an embedding field doc_embedding, the ranking expression
could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.

Here are a few examples of ranking formulas that use the supported
ranking expression types:

The following signals are supported:

string ranking_expression = 26 [(.google.api.field_behavior) = OPTIONAL];

Parameters:: value - The rankingExpression to set.
Returns:: This builder for chaining.

clearRankingExpression

public SearchRequest.Builder clearRankingExpression()

* ranking_expression = function, { " + ", function };

Supported functions:

* double * relevance_score
* double * dotProduct(embedding_field_path)

Function variables:

Example ranking expression:

If document has an embedding field doc_embedding, the ranking expression
could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.

Here are a few examples of ranking formulas that use the supported
ranking expression types:

The following signals are supported:

string ranking_expression = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns:: This builder for chaining.

setRankingExpressionBytes

public SearchRequest.Builder setRankingExpressionBytes(com.google.protobuf.ByteString value)

* ranking_expression = function, { " + ", function };

Supported functions:

* double * relevance_score
* double * dotProduct(embedding_field_path)

Function variables:

Example ranking expression:

If document has an embedding field doc_embedding, the ranking expression
could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.

Here are a few examples of ranking formulas that use the supported
ranking expression types:

The following signals are supported:

string ranking_expression = 26 [(.google.api.field_behavior) = OPTIONAL];

Parameters:: value - The bytes for rankingExpression to set.
Returns:: This builder for chaining.

getRankingExpressionBackendValue
```
public int getRankingExpressionBackendValue()
```
```
 Optional. The backend to use for the ranking expression evaluation.
 
```
.google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackend ranking_expression_backend = 53 [(.google.api.field_behavior) = OPTIONAL];
Specified by:

getRankingExpressionBackendValue in interface SearchRequestOrBuilder

Returns:

The enum numeric value on the wire for rankingExpressionBackend.

setRankingExpressionBackendValue
```
public SearchRequest.Builder setRankingExpressionBackendValue(int value)
```
```
 Optional. The backend to use for the ranking expression evaluation.
 
```
.google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackend ranking_expression_backend = 53 [(.google.api.field_behavior) = OPTIONAL];
Parameters:

value - The enum numeric value on the wire for rankingExpressionBackend to set.

Returns:

This builder for chaining.

getRankingExpressionBackend
```
public SearchRequest.RankingExpressionBackend getRankingExpressionBackend()
```
```
 Optional. The backend to use for the ranking expression evaluation.
 
```
.google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackend ranking_expression_backend = 53 [(.google.api.field_behavior) = OPTIONAL];
Specified by:

getRankingExpressionBackend in interface SearchRequestOrBuilder

Returns:

The rankingExpressionBackend.

setRankingExpressionBackend
```
public SearchRequest.Builder setRankingExpressionBackend(SearchRequest.RankingExpressionBackend value)
```
```
 Optional. The backend to use for the ranking expression evaluation.
 
```
.google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackend ranking_expression_backend = 53 [(.google.api.field_behavior) = OPTIONAL];
Parameters:

value - The rankingExpressionBackend to set.

Returns:

This builder for chaining.

clearRankingExpressionBackend
```
public SearchRequest.Builder clearRankingExpressionBackend()
```
```
 Optional. The backend to use for the ranking expression evaluation.
 
```
.google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackend ranking_expression_backend = 53 [(.google.api.field_behavior) = OPTIONAL];
Returns:

This builder for chaining.

getSafeSearch
```
public boolean getSafeSearch()
```
```
 Whether to turn on safe search. This is only supported for
 website search.
 
```
bool safe_search = 20;
Specified by:

getSafeSearch in interface SearchRequestOrBuilder

Returns:

The safeSearch.

setSafeSearch

public SearchRequest.Builder setSafeSearch(boolean value)

 Whether to turn on safe search. This is only supported for
 website search.

bool safe_search = 20;

Parameters:: value - The safeSearch to set.
Returns:: This builder for chaining.

clearSafeSearch

public SearchRequest.Builder clearSafeSearch()

 Whether to turn on safe search. This is only supported for
 website search.

bool safe_search = 20;

Returns:: This builder for chaining.

getUserLabelsCount

public int getUserLabelsCount()

Description copied from interface: SearchRequestOrBuilder

 The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
 characters and cannot be empty. Values can be empty and have a maximum
 length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes. All characters must use UTF-8 encoding, and
 international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
 key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.

map<string, string> user_labels = 22;

Specified by:: getUserLabelsCount in interface SearchRequestOrBuilder

containsUserLabels

public boolean containsUserLabels(String key)

 The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
 characters and cannot be empty. Values can be empty and have a maximum
 length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes. All characters must use UTF-8 encoding, and
 international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
 key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.

map<string, string> user_labels = 22;

Specified by:: containsUserLabels in interface SearchRequestOrBuilder

getUserLabels
```
@Deprecated
public Map<String,String> getUserLabels()
```
Deprecated.

Use getUserLabelsMap() instead.

Specified by:

getUserLabels in interface SearchRequestOrBuilder

getUserLabelsMap

public Map<String,String> getUserLabelsMap()

 The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
 characters and cannot be empty. Values can be empty and have a maximum
 length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes. All characters must use UTF-8 encoding, and
 international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
 key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.

map<string, string> user_labels = 22;

Specified by:: getUserLabelsMap in interface SearchRequestOrBuilder

getUserLabelsOrDefault

public String getUserLabelsOrDefault(String key,
                                     String defaultValue)

 The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
 characters and cannot be empty. Values can be empty and have a maximum
 length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes. All characters must use UTF-8 encoding, and
 international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
 key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.

map<string, string> user_labels = 22;

Specified by:: getUserLabelsOrDefault in interface SearchRequestOrBuilder

getUserLabelsOrThrow

public String getUserLabelsOrThrow(String key)

 The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
 characters and cannot be empty. Values can be empty and have a maximum
 length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes. All characters must use UTF-8 encoding, and
 international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
 key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.

map<string, string> user_labels = 22;

Specified by:: getUserLabelsOrThrow in interface SearchRequestOrBuilder

clearUserLabels

public SearchRequest.Builder clearUserLabels()

removeUserLabels

public SearchRequest.Builder removeUserLabels(String key)

 The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
 characters and cannot be empty. Values can be empty and have a maximum
 length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes. All characters must use UTF-8 encoding, and
 international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
 key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.

map<string, string> user_labels = 22;

getMutableUserLabels
```
@Deprecated
public Map<String,String> getMutableUserLabels()
```
Deprecated.

Use alternate mutation accessors instead.

putUserLabels

public SearchRequest.Builder putUserLabels(String key,
                                           String value)

 The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
 characters and cannot be empty. Values can be empty and have a maximum
 length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes. All characters must use UTF-8 encoding, and
 international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
 key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.

map<string, string> user_labels = 22;

putAllUserLabels

public SearchRequest.Builder putAllUserLabels(Map<String,String> values)

 The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
 characters and cannot be empty. Values can be empty and have a maximum
 length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes. All characters must use UTF-8 encoding, and
 international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
 key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.

map<string, string> user_labels = 22;

hasNaturalLanguageQueryUnderstandingSpec

public boolean hasNaturalLanguageQueryUnderstandingSpec()

 Optional. Config for natural language query understanding capabilities,
 such as extracting structured field filters from the query. Refer to [this
 documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries)
 for more information.
 If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
 natural language query understanding will be done.


 .google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec natural_language_query_understanding_spec = 28 [(.google.api.field_behavior) = OPTIONAL];

Specified by:: hasNaturalLanguageQueryUnderstandingSpec in interface SearchRequestOrBuilder
Returns:: Whether the naturalLanguageQueryUnderstandingSpec field is set.

getNaturalLanguageQueryUnderstandingSpec

public SearchRequest.NaturalLanguageQueryUnderstandingSpec getNaturalLanguageQueryUnderstandingSpec()

 Optional. Config for natural language query understanding capabilities,
 such as extracting structured field filters from the query. Refer to [this
 documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries)
 for more information.
 If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
 natural language query understanding will be done.


 .google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec natural_language_query_understanding_spec = 28 [(.google.api.field_behavior) = OPTIONAL];

Specified by:: getNaturalLanguageQueryUnderstandingSpec in interface SearchRequestOrBuilder
Returns:: The naturalLanguageQueryUnderstandingSpec.

setNaturalLanguageQueryUnderstandingSpec

public SearchRequest.Builder setNaturalLanguageQueryUnderstandingSpec(SearchRequest.NaturalLanguageQueryUnderstandingSpec value)

 Optional. Config for natural language query understanding capabilities,
 such as extracting structured field filters from the query. Refer to [this
 documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries)
 for more information.
 If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
 natural language query understanding will be done.


 .google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec natural_language_query_understanding_spec = 28 [(.google.api.field_behavior) = OPTIONAL];

setNaturalLanguageQueryUnderstandingSpec

public SearchRequest.Builder setNaturalLanguageQueryUnderstandingSpec(SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder builderForValue)

 Optional. Config for natural language query understanding capabilities,
 such as extracting structured field filters from the query. Refer to [this
 documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries)
 for more information.
 If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
 natural language query understanding will be done.


 .google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec natural_language_query_understanding_spec = 28 [(.google.api.field_behavior) = OPTIONAL];

mergeNaturalLanguageQueryUnderstandingSpec

public SearchRequest.Builder mergeNaturalLanguageQueryUnderstandingSpec(SearchRequest.NaturalLanguageQueryUnderstandingSpec value)

 Optional. Config for natural language query understanding capabilities,
 such as extracting structured field filters from the query. Refer to [this
 documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries)
 for more information.
 If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
 natural language query understanding will be done.


 .google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec natural_language_query_understanding_spec = 28 [(.google.api.field_behavior) = OPTIONAL];

clearNaturalLanguageQueryUnderstandingSpec

public SearchRequest.Builder clearNaturalLanguageQueryUnderstandingSpec()

 Optional. Config for natural language query understanding capabilities,
 such as extracting structured field filters from the query. Refer to [this
 documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries)
 for more information.
 If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
 natural language query understanding will be done.


 .google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec natural_language_query_understanding_spec = 28 [(.google.api.field_behavior) = OPTIONAL];

getNaturalLanguageQueryUnderstandingSpecBuilder

public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder getNaturalLanguageQueryUnderstandingSpecBuilder()

 Optional. Config for natural language query understanding capabilities,
 such as extracting structured field filters from the query. Refer to [this
 documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries)
 for more information.
 If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
 natural language query understanding will be done.


 .google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec natural_language_query_understanding_spec = 28 [(.google.api.field_behavior) = OPTIONAL];

getNaturalLanguageQueryUnderstandingSpecOrBuilder

public SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder getNaturalLanguageQueryUnderstandingSpecOrBuilder()

 Optional. Config for natural language query understanding capabilities,
 such as extracting structured field filters from the query. Refer to [this
 documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries)
 for more information.
 If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
 natural language query understanding will be done.


 .google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec natural_language_query_understanding_spec = 28 [(.google.api.field_behavior) = OPTIONAL];

Specified by:: getNaturalLanguageQueryUnderstandingSpecOrBuilder in interface SearchRequestOrBuilder

hasSearchAsYouTypeSpec
```
public boolean hasSearchAsYouTypeSpec()
```
```
 Search as you type configuration. Only supported for the
 [IndustryVertical.MEDIA][google.cloud.discoveryengine.v1.IndustryVertical.MEDIA]
 vertical.
 
```
.google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec search_as_you_type_spec = 31;
Specified by:

hasSearchAsYouTypeSpec in interface SearchRequestOrBuilder

Returns:

Whether the searchAsYouTypeSpec field is set.

getSearchAsYouTypeSpec

public SearchRequest.SearchAsYouTypeSpec getSearchAsYouTypeSpec()

 Search as you type configuration. Only supported for the
 [IndustryVertical.MEDIA][google.cloud.discoveryengine.v1.IndustryVertical.MEDIA]
 vertical.


 .google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec search_as_you_type_spec = 31;

Specified by:: getSearchAsYouTypeSpec in interface SearchRequestOrBuilder
Returns:: The searchAsYouTypeSpec.

setSearchAsYouTypeSpec

public SearchRequest.Builder setSearchAsYouTypeSpec(SearchRequest.SearchAsYouTypeSpec value)

 Search as you type configuration. Only supported for the
 [IndustryVertical.MEDIA][google.cloud.discoveryengine.v1.IndustryVertical.MEDIA]
 vertical.


 .google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec search_as_you_type_spec = 31;

setSearchAsYouTypeSpec

public SearchRequest.Builder setSearchAsYouTypeSpec(SearchRequest.SearchAsYouTypeSpec.Builder builderForValue)

 Search as you type configuration. Only supported for the
 [IndustryVertical.MEDIA][google.cloud.discoveryengine.v1.IndustryVertical.MEDIA]
 vertical.


 .google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec search_as_you_type_spec = 31;

mergeSearchAsYouTypeSpec

public SearchRequest.Builder mergeSearchAsYouTypeSpec(SearchRequest.SearchAsYouTypeSpec value)

 Search as you type configuration. Only supported for the
 [IndustryVertical.MEDIA][google.cloud.discoveryengine.v1.IndustryVertical.MEDIA]
 vertical.


 .google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec search_as_you_type_spec = 31;

clearSearchAsYouTypeSpec

public SearchRequest.Builder clearSearchAsYouTypeSpec()

 Search as you type configuration. Only supported for the
 [IndustryVertical.MEDIA][google.cloud.discoveryengine.v1.IndustryVertical.MEDIA]
 vertical.


 .google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec search_as_you_type_spec = 31;

getSearchAsYouTypeSpecBuilder

public SearchRequest.SearchAsYouTypeSpec.Builder getSearchAsYouTypeSpecBuilder()

 Search as you type configuration. Only supported for the
 [IndustryVertical.MEDIA][google.cloud.discoveryengine.v1.IndustryVertical.MEDIA]
 vertical.


 .google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec search_as_you_type_spec = 31;

getSearchAsYouTypeSpecOrBuilder

public SearchRequest.SearchAsYouTypeSpecOrBuilder getSearchAsYouTypeSpecOrBuilder()

 Search as you type configuration. Only supported for the
 [IndustryVertical.MEDIA][google.cloud.discoveryengine.v1.IndustryVertical.MEDIA]
 vertical.


 .google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec search_as_you_type_spec = 31;

Specified by:: getSearchAsYouTypeSpecOrBuilder in interface SearchRequestOrBuilder

hasDisplaySpec
```
public boolean hasDisplaySpec()
```
```
 Optional. Config for display feature, like match highlighting on search
 results.
 
```
.google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec display_spec = 38 [(.google.api.field_behavior) = OPTIONAL];
Specified by:

hasDisplaySpec in interface SearchRequestOrBuilder

Returns:

Whether the displaySpec field is set.

getDisplaySpec
```
public SearchRequest.DisplaySpec getDisplaySpec()
```
```
 Optional. Config for display feature, like match highlighting on search
 results.
 
```
.google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec display_spec = 38 [(.google.api.field_behavior) = OPTIONAL];
Specified by:

getDisplaySpec in interface SearchRequestOrBuilder

Returns:

The displaySpec.

setDisplaySpec

public SearchRequest.Builder setDisplaySpec(SearchRequest.DisplaySpec value)

 Optional. Config for display feature, like match highlighting on search
 results.


 .google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec display_spec = 38 [(.google.api.field_behavior) = OPTIONAL];

setDisplaySpec

public SearchRequest.Builder setDisplaySpec(SearchRequest.DisplaySpec.Builder builderForValue)

 Optional. Config for display feature, like match highlighting on search
 results.


 .google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec display_spec = 38 [(.google.api.field_behavior) = OPTIONAL];

mergeDisplaySpec

public SearchRequest.Builder mergeDisplaySpec(SearchRequest.DisplaySpec value)

 Optional. Config for display feature, like match highlighting on search
 results.


 .google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec display_spec = 38 [(.google.api.field_behavior) = OPTIONAL];

clearDisplaySpec

public SearchRequest.Builder clearDisplaySpec()

 Optional. Config for display feature, like match highlighting on search
 results.


 .google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec display_spec = 38 [(.google.api.field_behavior) = OPTIONAL];

getDisplaySpecBuilder

public SearchRequest.DisplaySpec.Builder getDisplaySpecBuilder()

 Optional. Config for display feature, like match highlighting on search
 results.


 .google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec display_spec = 38 [(.google.api.field_behavior) = OPTIONAL];

getDisplaySpecOrBuilder
```
public SearchRequest.DisplaySpecOrBuilder getDisplaySpecOrBuilder()
```
```
 Optional. Config for display feature, like match highlighting on search
 results.
 
```
.google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec display_spec = 38 [(.google.api.field_behavior) = OPTIONAL];
Specified by:

getDisplaySpecOrBuilder in interface SearchRequestOrBuilder

getCrowdingSpecsList

public List<SearchRequest.CrowdingSpec> getCrowdingSpecsList()

 Optional. Crowding specifications for improving result diversity.
 If multiple CrowdingSpecs are specified, crowding will be evaluated on
 each unique combination of the `field` values, and max_count will be the
 maximum value of `max_count` across all CrowdingSpecs.
 For example, if the first CrowdingSpec has `field` = "color" and
 `max_count` = 3, and the second CrowdingSpec has `field` = "size" and
 `max_count` = 2, then after 3 documents that share the same color AND size
 have been returned, subsequent ones should be
 removed or demoted.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec crowding_specs = 40 [(.google.api.field_behavior) = OPTIONAL];

Specified by:: getCrowdingSpecsList in interface SearchRequestOrBuilder

getCrowdingSpecsCount

public int getCrowdingSpecsCount()

 Optional. Crowding specifications for improving result diversity.
 If multiple CrowdingSpecs are specified, crowding will be evaluated on
 each unique combination of the `field` values, and max_count will be the
 maximum value of `max_count` across all CrowdingSpecs.
 For example, if the first CrowdingSpec has `field` = "color" and
 `max_count` = 3, and the second CrowdingSpec has `field` = "size" and
 `max_count` = 2, then after 3 documents that share the same color AND size
 have been returned, subsequent ones should be
 removed or demoted.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec crowding_specs = 40 [(.google.api.field_behavior) = OPTIONAL];

Specified by:: getCrowdingSpecsCount in interface SearchRequestOrBuilder

getCrowdingSpecs

public SearchRequest.CrowdingSpec getCrowdingSpecs(int index)

 Optional. Crowding specifications for improving result diversity.
 If multiple CrowdingSpecs are specified, crowding will be evaluated on
 each unique combination of the `field` values, and max_count will be the
 maximum value of `max_count` across all CrowdingSpecs.
 For example, if the first CrowdingSpec has `field` = "color" and
 `max_count` = 3, and the second CrowdingSpec has `field` = "size" and
 `max_count` = 2, then after 3 documents that share the same color AND size
 have been returned, subsequent ones should be
 removed or demoted.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec crowding_specs = 40 [(.google.api.field_behavior) = OPTIONAL];

Specified by:: getCrowdingSpecs in interface SearchRequestOrBuilder

setCrowdingSpecs

public SearchRequest.Builder setCrowdingSpecs(int index,
                                              SearchRequest.CrowdingSpec value)

 Optional. Crowding specifications for improving result diversity.
 If multiple CrowdingSpecs are specified, crowding will be evaluated on
 each unique combination of the `field` values, and max_count will be the
 maximum value of `max_count` across all CrowdingSpecs.
 For example, if the first CrowdingSpec has `field` = "color" and
 `max_count` = 3, and the second CrowdingSpec has `field` = "size" and
 `max_count` = 2, then after 3 documents that share the same color AND size
 have been returned, subsequent ones should be
 removed or demoted.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec crowding_specs = 40 [(.google.api.field_behavior) = OPTIONAL];

setCrowdingSpecs

public SearchRequest.Builder setCrowdingSpecs(int index,
                                              SearchRequest.CrowdingSpec.Builder builderForValue)

 Optional. Crowding specifications for improving result diversity.
 If multiple CrowdingSpecs are specified, crowding will be evaluated on
 each unique combination of the `field` values, and max_count will be the
 maximum value of `max_count` across all CrowdingSpecs.
 For example, if the first CrowdingSpec has `field` = "color" and
 `max_count` = 3, and the second CrowdingSpec has `field` = "size" and
 `max_count` = 2, then after 3 documents that share the same color AND size
 have been returned, subsequent ones should be
 removed or demoted.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec crowding_specs = 40 [(.google.api.field_behavior) = OPTIONAL];

addCrowdingSpecs

public SearchRequest.Builder addCrowdingSpecs(SearchRequest.CrowdingSpec value)

 Optional. Crowding specifications for improving result diversity.
 If multiple CrowdingSpecs are specified, crowding will be evaluated on
 each unique combination of the `field` values, and max_count will be the
 maximum value of `max_count` across all CrowdingSpecs.
 For example, if the first CrowdingSpec has `field` = "color" and
 `max_count` = 3, and the second CrowdingSpec has `field` = "size" and
 `max_count` = 2, then after 3 documents that share the same color AND size
 have been returned, subsequent ones should be
 removed or demoted.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec crowding_specs = 40 [(.google.api.field_behavior) = OPTIONAL];

addCrowdingSpecs

public SearchRequest.Builder addCrowdingSpecs(int index,
                                              SearchRequest.CrowdingSpec value)

 Optional. Crowding specifications for improving result diversity.
 If multiple CrowdingSpecs are specified, crowding will be evaluated on
 each unique combination of the `field` values, and max_count will be the
 maximum value of `max_count` across all CrowdingSpecs.
 For example, if the first CrowdingSpec has `field` = "color" and
 `max_count` = 3, and the second CrowdingSpec has `field` = "size" and
 `max_count` = 2, then after 3 documents that share the same color AND size
 have been returned, subsequent ones should be
 removed or demoted.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec crowding_specs = 40 [(.google.api.field_behavior) = OPTIONAL];

addCrowdingSpecs

public SearchRequest.Builder addCrowdingSpecs(SearchRequest.CrowdingSpec.Builder builderForValue)

 Optional. Crowding specifications for improving result diversity.
 If multiple CrowdingSpecs are specified, crowding will be evaluated on
 each unique combination of the `field` values, and max_count will be the
 maximum value of `max_count` across all CrowdingSpecs.
 For example, if the first CrowdingSpec has `field` = "color" and
 `max_count` = 3, and the second CrowdingSpec has `field` = "size" and
 `max_count` = 2, then after 3 documents that share the same color AND size
 have been returned, subsequent ones should be
 removed or demoted.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec crowding_specs = 40 [(.google.api.field_behavior) = OPTIONAL];

addCrowdingSpecs

public SearchRequest.Builder addCrowdingSpecs(int index,
                                              SearchRequest.CrowdingSpec.Builder builderForValue)

 Optional. Crowding specifications for improving result diversity.
 If multiple CrowdingSpecs are specified, crowding will be evaluated on
 each unique combination of the `field` values, and max_count will be the
 maximum value of `max_count` across all CrowdingSpecs.
 For example, if the first CrowdingSpec has `field` = "color" and
 `max_count` = 3, and the second CrowdingSpec has `field` = "size" and
 `max_count` = 2, then after 3 documents that share the same color AND size
 have been returned, subsequent ones should be
 removed or demoted.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec crowding_specs = 40 [(.google.api.field_behavior) = OPTIONAL];

addAllCrowdingSpecs

public SearchRequest.Builder addAllCrowdingSpecs(Iterable<? extends SearchRequest.CrowdingSpec> values)

 Optional. Crowding specifications for improving result diversity.
 If multiple CrowdingSpecs are specified, crowding will be evaluated on
 each unique combination of the `field` values, and max_count will be the
 maximum value of `max_count` across all CrowdingSpecs.
 For example, if the first CrowdingSpec has `field` = "color" and
 `max_count` = 3, and the second CrowdingSpec has `field` = "size" and
 `max_count` = 2, then after 3 documents that share the same color AND size
 have been returned, subsequent ones should be
 removed or demoted.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec crowding_specs = 40 [(.google.api.field_behavior) = OPTIONAL];

clearCrowdingSpecs

public SearchRequest.Builder clearCrowdingSpecs()

 Optional. Crowding specifications for improving result diversity.
 If multiple CrowdingSpecs are specified, crowding will be evaluated on
 each unique combination of the `field` values, and max_count will be the
 maximum value of `max_count` across all CrowdingSpecs.
 For example, if the first CrowdingSpec has `field` = "color" and
 `max_count` = 3, and the second CrowdingSpec has `field` = "size" and
 `max_count` = 2, then after 3 documents that share the same color AND size
 have been returned, subsequent ones should be
 removed or demoted.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec crowding_specs = 40 [(.google.api.field_behavior) = OPTIONAL];

removeCrowdingSpecs

public SearchRequest.Builder removeCrowdingSpecs(int index)

 Optional. Crowding specifications for improving result diversity.
 If multiple CrowdingSpecs are specified, crowding will be evaluated on
 each unique combination of the `field` values, and max_count will be the
 maximum value of `max_count` across all CrowdingSpecs.
 For example, if the first CrowdingSpec has `field` = "color" and
 `max_count` = 3, and the second CrowdingSpec has `field` = "size" and
 `max_count` = 2, then after 3 documents that share the same color AND size
 have been returned, subsequent ones should be
 removed or demoted.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec crowding_specs = 40 [(.google.api.field_behavior) = OPTIONAL];

getCrowdingSpecsBuilder

public SearchRequest.CrowdingSpec.Builder getCrowdingSpecsBuilder(int index)

 Optional. Crowding specifications for improving result diversity.
 If multiple CrowdingSpecs are specified, crowding will be evaluated on
 each unique combination of the `field` values, and max_count will be the
 maximum value of `max_count` across all CrowdingSpecs.
 For example, if the first CrowdingSpec has `field` = "color" and
 `max_count` = 3, and the second CrowdingSpec has `field` = "size" and
 `max_count` = 2, then after 3 documents that share the same color AND size
 have been returned, subsequent ones should be
 removed or demoted.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec crowding_specs = 40 [(.google.api.field_behavior) = OPTIONAL];

getCrowdingSpecsOrBuilder

public SearchRequest.CrowdingSpecOrBuilder getCrowdingSpecsOrBuilder(int index)

 Optional. Crowding specifications for improving result diversity.
 If multiple CrowdingSpecs are specified, crowding will be evaluated on
 each unique combination of the `field` values, and max_count will be the
 maximum value of `max_count` across all CrowdingSpecs.
 For example, if the first CrowdingSpec has `field` = "color" and
 `max_count` = 3, and the second CrowdingSpec has `field` = "size" and
 `max_count` = 2, then after 3 documents that share the same color AND size
 have been returned, subsequent ones should be
 removed or demoted.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec crowding_specs = 40 [(.google.api.field_behavior) = OPTIONAL];

Specified by:: getCrowdingSpecsOrBuilder in interface SearchRequestOrBuilder

getCrowdingSpecsOrBuilderList

public List<? extends SearchRequest.CrowdingSpecOrBuilder> getCrowdingSpecsOrBuilderList()

 Optional. Crowding specifications for improving result diversity.
 If multiple CrowdingSpecs are specified, crowding will be evaluated on
 each unique combination of the `field` values, and max_count will be the
 maximum value of `max_count` across all CrowdingSpecs.
 For example, if the first CrowdingSpec has `field` = "color" and
 `max_count` = 3, and the second CrowdingSpec has `field` = "size" and
 `max_count` = 2, then after 3 documents that share the same color AND size
 have been returned, subsequent ones should be
 removed or demoted.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec crowding_specs = 40 [(.google.api.field_behavior) = OPTIONAL];

Specified by:: getCrowdingSpecsOrBuilderList in interface SearchRequestOrBuilder

addCrowdingSpecsBuilder

public SearchRequest.CrowdingSpec.Builder addCrowdingSpecsBuilder()

 Optional. Crowding specifications for improving result diversity.
 If multiple CrowdingSpecs are specified, crowding will be evaluated on
 each unique combination of the `field` values, and max_count will be the
 maximum value of `max_count` across all CrowdingSpecs.
 For example, if the first CrowdingSpec has `field` = "color" and
 `max_count` = 3, and the second CrowdingSpec has `field` = "size" and
 `max_count` = 2, then after 3 documents that share the same color AND size
 have been returned, subsequent ones should be
 removed or demoted.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec crowding_specs = 40 [(.google.api.field_behavior) = OPTIONAL];

addCrowdingSpecsBuilder

public SearchRequest.CrowdingSpec.Builder addCrowdingSpecsBuilder(int index)

 Optional. Crowding specifications for improving result diversity.
 If multiple CrowdingSpecs are specified, crowding will be evaluated on
 each unique combination of the `field` values, and max_count will be the
 maximum value of `max_count` across all CrowdingSpecs.
 For example, if the first CrowdingSpec has `field` = "color" and
 `max_count` = 3, and the second CrowdingSpec has `field` = "size" and
 `max_count` = 2, then after 3 documents that share the same color AND size
 have been returned, subsequent ones should be
 removed or demoted.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec crowding_specs = 40 [(.google.api.field_behavior) = OPTIONAL];

getCrowdingSpecsBuilderList

public List<SearchRequest.CrowdingSpec.Builder> getCrowdingSpecsBuilderList()

 Optional. Crowding specifications for improving result diversity.
 If multiple CrowdingSpecs are specified, crowding will be evaluated on
 each unique combination of the `field` values, and max_count will be the
 maximum value of `max_count` across all CrowdingSpecs.
 For example, if the first CrowdingSpec has `field` = "color" and
 `max_count` = 3, and the second CrowdingSpec has `field` = "size" and
 `max_count` = 2, then after 3 documents that share the same color AND size
 have been returned, subsequent ones should be
 removed or demoted.


 repeated .google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec crowding_specs = 40 [(.google.api.field_behavior) = OPTIONAL];

getSession

public String getSession()

 The session resource name. Optional.

 Session allows users to do multi-turn /search API calls or coordination
 between /search API calls and /answer API calls.

 Example #1 (multi-turn /search API calls):
 Call /search API with the session ID generated in the first call.
 Here, the previous search query gets considered in query
 standing. I.e., if the first query is "How did Alphabet do in 2022?"
 and the current query is "How about 2023?", the current query will
 be interpreted as "How did Alphabet do in 2023?".

 Example #2 (coordination between /search API calls and /answer API calls):
 Call /answer API with the session ID generated in the first call.
 Here, the answer generation happens in the context of the search
 results from the first search call.

 Multi-turn Search feature is currently at private GA stage. Please use
 v1alpha or v1beta version instead before we launch this feature to public
 GA. Or ask for allowlisting through Google Support team.

string session = 41 [(.google.api.resource_reference) = { ... }

Specified by:: getSession in interface SearchRequestOrBuilder
Returns:: The session.

getSessionBytes

public com.google.protobuf.ByteString getSessionBytes()

 The session resource name. Optional.

 Session allows users to do multi-turn /search API calls or coordination
 between /search API calls and /answer API calls.

 Example #1 (multi-turn /search API calls):
 Call /search API with the session ID generated in the first call.
 Here, the previous search query gets considered in query
 standing. I.e., if the first query is "How did Alphabet do in 2022?"
 and the current query is "How about 2023?", the current query will
 be interpreted as "How did Alphabet do in 2023?".

 Example #2 (coordination between /search API calls and /answer API calls):
 Call /answer API with the session ID generated in the first call.
 Here, the answer generation happens in the context of the search
 results from the first search call.

 Multi-turn Search feature is currently at private GA stage. Please use
 v1alpha or v1beta version instead before we launch this feature to public
 GA. Or ask for allowlisting through Google Support team.

string session = 41 [(.google.api.resource_reference) = { ... }

Specified by:: getSessionBytes in interface SearchRequestOrBuilder
Returns:: The bytes for session.

setSession

public SearchRequest.Builder setSession(String value)

 The session resource name. Optional.

 Session allows users to do multi-turn /search API calls or coordination
 between /search API calls and /answer API calls.

 Example #1 (multi-turn /search API calls):
 Call /search API with the session ID generated in the first call.
 Here, the previous search query gets considered in query
 standing. I.e., if the first query is "How did Alphabet do in 2022?"
 and the current query is "How about 2023?", the current query will
 be interpreted as "How did Alphabet do in 2023?".

 Example #2 (coordination between /search API calls and /answer API calls):
 Call /answer API with the session ID generated in the first call.
 Here, the answer generation happens in the context of the search
 results from the first search call.

 Multi-turn Search feature is currently at private GA stage. Please use
 v1alpha or v1beta version instead before we launch this feature to public
 GA. Or ask for allowlisting through Google Support team.

string session = 41 [(.google.api.resource_reference) = { ... }

Parameters:: value - The session to set.
Returns:: This builder for chaining.

clearSession

public SearchRequest.Builder clearSession()

 The session resource name. Optional.

 Session allows users to do multi-turn /search API calls or coordination
 between /search API calls and /answer API calls.

 Example #1 (multi-turn /search API calls):
 Call /search API with the session ID generated in the first call.
 Here, the previous search query gets considered in query
 standing. I.e., if the first query is "How did Alphabet do in 2022?"
 and the current query is "How about 2023?", the current query will
 be interpreted as "How did Alphabet do in 2023?".

 Example #2 (coordination between /search API calls and /answer API calls):
 Call /answer API with the session ID generated in the first call.
 Here, the answer generation happens in the context of the search
 results from the first search call.

 Multi-turn Search feature is currently at private GA stage. Please use
 v1alpha or v1beta version instead before we launch this feature to public
 GA. Or ask for allowlisting through Google Support team.

string session = 41 [(.google.api.resource_reference) = { ... }

Returns:: This builder for chaining.

setSessionBytes

public SearchRequest.Builder setSessionBytes(com.google.protobuf.ByteString value)

 The session resource name. Optional.

 Session allows users to do multi-turn /search API calls or coordination
 between /search API calls and /answer API calls.

 Example #1 (multi-turn /search API calls):
 Call /search API with the session ID generated in the first call.
 Here, the previous search query gets considered in query
 standing. I.e., if the first query is "How did Alphabet do in 2022?"
 and the current query is "How about 2023?", the current query will
 be interpreted as "How did Alphabet do in 2023?".

 Example #2 (coordination between /search API calls and /answer API calls):
 Call /answer API with the session ID generated in the first call.
 Here, the answer generation happens in the context of the search
 results from the first search call.

 Multi-turn Search feature is currently at private GA stage. Please use
 v1alpha or v1beta version instead before we launch this feature to public
 GA. Or ask for allowlisting through Google Support team.

string session = 41 [(.google.api.resource_reference) = { ... }

Parameters:: value - The bytes for session to set.
Returns:: This builder for chaining.

hasSessionSpec
```
public boolean hasSessionSpec()
```
```
 Session specification.

 Can be used only when `session` is set.
 
```
.google.cloud.discoveryengine.v1.SearchRequest.SessionSpec session_spec = 42;
Specified by:

hasSessionSpec in interface SearchRequestOrBuilder

Returns:

Whether the sessionSpec field is set.

getSessionSpec
```
public SearchRequest.SessionSpec getSessionSpec()
```
```
 Session specification.

 Can be used only when `session` is set.
 
```
.google.cloud.discoveryengine.v1.SearchRequest.SessionSpec session_spec = 42;
Specified by:

getSessionSpec in interface SearchRequestOrBuilder

Returns:

The sessionSpec.

setSessionSpec

public SearchRequest.Builder setSessionSpec(SearchRequest.SessionSpec value)

 Session specification.

 Can be used only when `session` is set.

.google.cloud.discoveryengine.v1.SearchRequest.SessionSpec session_spec = 42;

setSessionSpec

public SearchRequest.Builder setSessionSpec(SearchRequest.SessionSpec.Builder builderForValue)

 Session specification.

 Can be used only when `session` is set.

.google.cloud.discoveryengine.v1.SearchRequest.SessionSpec session_spec = 42;

mergeSessionSpec

public SearchRequest.Builder mergeSessionSpec(SearchRequest.SessionSpec value)

 Session specification.

 Can be used only when `session` is set.

.google.cloud.discoveryengine.v1.SearchRequest.SessionSpec session_spec = 42;

clearSessionSpec

public SearchRequest.Builder clearSessionSpec()

 Session specification.

 Can be used only when `session` is set.

.google.cloud.discoveryengine.v1.SearchRequest.SessionSpec session_spec = 42;

getSessionSpecBuilder

public SearchRequest.SessionSpec.Builder getSessionSpecBuilder()

 Session specification.

 Can be used only when `session` is set.

.google.cloud.discoveryengine.v1.SearchRequest.SessionSpec session_spec = 42;

getSessionSpecOrBuilder
```
public SearchRequest.SessionSpecOrBuilder getSessionSpecOrBuilder()
```
```
 Session specification.

 Can be used only when `session` is set.
 
```
.google.cloud.discoveryengine.v1.SearchRequest.SessionSpec session_spec = 42;
Specified by:

getSessionSpecOrBuilder in interface SearchRequestOrBuilder

getRelevanceThresholdValue

public int getRelevanceThresholdValue()

 The global relevance threshold of the search results.

 Defaults to Google defined threshold, leveraging a balance of
 precision and recall to deliver both highly accurate results and
 comprehensive coverage of relevant information.

 If more granular relevance filtering is required, use the
 `relevance_filter_spec` instead.

 This feature is not supported for healthcare search.


 .google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold relevance_threshold = 44;

Specified by:: getRelevanceThresholdValue in interface SearchRequestOrBuilder
Returns:: The enum numeric value on the wire for relevanceThreshold.

setRelevanceThresholdValue

public SearchRequest.Builder setRelevanceThresholdValue(int value)

 The global relevance threshold of the search results.

 Defaults to Google defined threshold, leveraging a balance of
 precision and recall to deliver both highly accurate results and
 comprehensive coverage of relevant information.

 If more granular relevance filtering is required, use the
 `relevance_filter_spec` instead.

 This feature is not supported for healthcare search.


 .google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold relevance_threshold = 44;

Parameters:: value - The enum numeric value on the wire for relevanceThreshold to set.
Returns:: This builder for chaining.

getRelevanceThreshold

public SearchRequest.RelevanceThreshold getRelevanceThreshold()

 The global relevance threshold of the search results.

 Defaults to Google defined threshold, leveraging a balance of
 precision and recall to deliver both highly accurate results and
 comprehensive coverage of relevant information.

 If more granular relevance filtering is required, use the
 `relevance_filter_spec` instead.

 This feature is not supported for healthcare search.


 .google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold relevance_threshold = 44;

Specified by:: getRelevanceThreshold in interface SearchRequestOrBuilder
Returns:: The relevanceThreshold.

setRelevanceThreshold

public SearchRequest.Builder setRelevanceThreshold(SearchRequest.RelevanceThreshold value)

 The global relevance threshold of the search results.

 Defaults to Google defined threshold, leveraging a balance of
 precision and recall to deliver both highly accurate results and
 comprehensive coverage of relevant information.

 If more granular relevance filtering is required, use the
 `relevance_filter_spec` instead.

 This feature is not supported for healthcare search.


 .google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold relevance_threshold = 44;

Parameters:: value - The relevanceThreshold to set.
Returns:: This builder for chaining.

clearRelevanceThreshold

public SearchRequest.Builder clearRelevanceThreshold()

 The global relevance threshold of the search results.

 Defaults to Google defined threshold, leveraging a balance of
 precision and recall to deliver both highly accurate results and
 comprehensive coverage of relevant information.

 If more granular relevance filtering is required, use the
 `relevance_filter_spec` instead.

 This feature is not supported for healthcare search.


 .google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold relevance_threshold = 44;

Returns:: This builder for chaining.

hasRelevanceScoreSpec
```
public boolean hasRelevanceScoreSpec()
```
```
 Optional. The specification for returning the relevance score.
 
```
.google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec relevance_score_spec = 52 [(.google.api.field_behavior) = OPTIONAL];
Specified by:

hasRelevanceScoreSpec in interface SearchRequestOrBuilder

Returns:

Whether the relevanceScoreSpec field is set.

getRelevanceScoreSpec
```
public SearchRequest.RelevanceScoreSpec getRelevanceScoreSpec()
```
```
 Optional. The specification for returning the relevance score.
 
```
.google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec relevance_score_spec = 52 [(.google.api.field_behavior) = OPTIONAL];
Specified by:

getRelevanceScoreSpec in interface SearchRequestOrBuilder

Returns:

The relevanceScoreSpec.

setRelevanceScoreSpec

public SearchRequest.Builder setRelevanceScoreSpec(SearchRequest.RelevanceScoreSpec value)

 Optional. The specification for returning the relevance score.


 .google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec relevance_score_spec = 52 [(.google.api.field_behavior) = OPTIONAL];

setRelevanceScoreSpec

public SearchRequest.Builder setRelevanceScoreSpec(SearchRequest.RelevanceScoreSpec.Builder builderForValue)

 Optional. The specification for returning the relevance score.


 .google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec relevance_score_spec = 52 [(.google.api.field_behavior) = OPTIONAL];

mergeRelevanceScoreSpec

public SearchRequest.Builder mergeRelevanceScoreSpec(SearchRequest.RelevanceScoreSpec value)

 Optional. The specification for returning the relevance score.


 .google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec relevance_score_spec = 52 [(.google.api.field_behavior) = OPTIONAL];

clearRelevanceScoreSpec
```
public SearchRequest.Builder clearRelevanceScoreSpec()
```
```
 Optional. The specification for returning the relevance score.
 
```
.google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec relevance_score_spec = 52 [(.google.api.field_behavior) = OPTIONAL];

getRelevanceScoreSpecBuilder
```
public SearchRequest.RelevanceScoreSpec.Builder getRelevanceScoreSpecBuilder()
```
```
 Optional. The specification for returning the relevance score.
 
```
.google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec relevance_score_spec = 52 [(.google.api.field_behavior) = OPTIONAL];

getRelevanceScoreSpecOrBuilder
```
public SearchRequest.RelevanceScoreSpecOrBuilder getRelevanceScoreSpecOrBuilder()
```
```
 Optional. The specification for returning the relevance score.
 
```
.google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec relevance_score_spec = 52 [(.google.api.field_behavior) = OPTIONAL];
Specified by:

getRelevanceScoreSpecOrBuilder in interface SearchRequestOrBuilder

Class SearchRequest.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.Message.Builder

Methods inherited from interface com.google.protobuf.MessageLite.Builder

Method Detail

getDescriptor

internalGetMapFieldReflection

internalGetMutableMapFieldReflection

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

mergeFrom

mergeFrom

isInitialized

mergeFrom

getServingConfig

getServingConfigBytes

setServingConfig

clearServingConfig

setServingConfigBytes

getBranch

getBranchBytes

setBranch

clearBranch

setBranchBytes

getQuery

getQueryBytes

setQuery

clearQuery

setQueryBytes

getPageCategoriesList

getPageCategoriesCount

getPageCategories

getPageCategoriesBytes

setPageCategories

addPageCategories

addAllPageCategories

clearPageCategories

addPageCategoriesBytes

hasImageQuery

getImageQuery

setImageQuery

setImageQuery

mergeImageQuery

clearImageQuery

getImageQueryBuilder

getImageQueryOrBuilder

getPageSize

setPageSize

clearPageSize

getPageToken

getPageTokenBytes

setPageToken

clearPageToken

setPageTokenBytes

getOffset

setOffset

clearOffset

getOneBoxPageSize

setOneBoxPageSize

clearOneBoxPageSize

getDataStoreSpecsList

getDataStoreSpecsCount

getDataStoreSpecs

setDataStoreSpecs

setDataStoreSpecs

addDataStoreSpecs

addDataStoreSpecs

addDataStoreSpecs

addDataStoreSpecs

addAllDataStoreSpecs

clearDataStoreSpecs