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

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessage
    - - com.google.cloud.discoveryengine.v1.SearchRequest

All Implemented Interfaces:

SearchRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
```
@Generated
public final class SearchRequest
extends com.google.protobuf.GeneratedMessage
implements SearchRequestOrBuilder
```
```
 Request message for
 [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
 method.
 
```
Protobuf type google.cloud.discoveryengine.v1.SearchRequest
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SearchRequest.BoostSpec` Boost specification to boost certain documents.
`static interface`	`SearchRequest.BoostSpecOrBuilder`
`static class`	`SearchRequest.Builder` Request message for [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] method.
`static class`	`SearchRequest.ContentSearchSpec` A specification for configuring the behavior of content search.
`static interface`	`SearchRequest.ContentSearchSpecOrBuilder`
`static class`	`SearchRequest.CrowdingSpec` Specification for crowding.
`static interface`	`SearchRequest.CrowdingSpecOrBuilder`
`static class`	`SearchRequest.DataStoreSpec` A struct to define data stores to filter on in a search call and configurations for those data stores.
`static interface`	`SearchRequest.DataStoreSpecOrBuilder`
`static class`	`SearchRequest.DisplaySpec` Specifies features for display, like match highlighting.
`static interface`	`SearchRequest.DisplaySpecOrBuilder`
`static class`	`SearchRequest.FacetSpec` A facet specification to perform faceted search.
`static interface`	`SearchRequest.FacetSpecOrBuilder`
`static class`	`SearchRequest.ImageQuery` Specifies the image query input.
`static interface`	`SearchRequest.ImageQueryOrBuilder`
`static class`	`SearchRequest.NaturalLanguageQueryUnderstandingSpec` Specification to enable natural language understanding capabilities for search requests.
`static interface`	`SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder`
`static class`	`SearchRequest.QueryExpansionSpec` Specification to determine under which conditions query expansion should occur.
`static interface`	`SearchRequest.QueryExpansionSpecOrBuilder`
`static class`	`SearchRequest.RankingExpressionBackend` The backend to use for the ranking expression evaluation.
`static class`	`SearchRequest.RelevanceScoreSpec` The specification for returning the document relevance score.
`static interface`	`SearchRequest.RelevanceScoreSpecOrBuilder`
`static class`	`SearchRequest.RelevanceThreshold` The relevance threshold of the search results.
`static class`	`SearchRequest.SearchAsYouTypeSpec` Specification for search as you type in search requests.
`static interface`	`SearchRequest.SearchAsYouTypeSpecOrBuilder`
`static class`	`SearchRequest.SessionSpec` Session specification.
`static interface`	`SearchRequest.SessionSpecOrBuilder`
`static class`	`SearchRequest.SpellCorrectionSpec` The specification for query spell correction.
`static interface`	`SearchRequest.SpellCorrectionSpecOrBuilder`

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BOOST_SPEC_FIELD_NUMBER`
`static int`	`BRANCH_FIELD_NUMBER`
`static int`	`CANONICAL_FILTER_FIELD_NUMBER`
`static int`	`CONTENT_SEARCH_SPEC_FIELD_NUMBER`
`static int`	`CROWDING_SPECS_FIELD_NUMBER`
`static int`	`DATA_STORE_SPECS_FIELD_NUMBER`
`static int`	`DISPLAY_SPEC_FIELD_NUMBER`
`static int`	`FACET_SPECS_FIELD_NUMBER`
`static int`	`FILTER_FIELD_NUMBER`
`static int`	`IMAGE_QUERY_FIELD_NUMBER`
`static int`	`LANGUAGE_CODE_FIELD_NUMBER`
`static int`	`NATURAL_LANGUAGE_QUERY_UNDERSTANDING_SPEC_FIELD_NUMBER`
`static int`	`OFFSET_FIELD_NUMBER`
`static int`	`ONE_BOX_PAGE_SIZE_FIELD_NUMBER`
`static int`	`ORDER_BY_FIELD_NUMBER`
`static int`	`PAGE_CATEGORIES_FIELD_NUMBER`
`static int`	`PAGE_SIZE_FIELD_NUMBER`
`static int`	`PAGE_TOKEN_FIELD_NUMBER`
`static int`	`PARAMS_FIELD_NUMBER`
`static int`	`QUERY_EXPANSION_SPEC_FIELD_NUMBER`
`static int`	`QUERY_FIELD_NUMBER`
`static int`	`RANKING_EXPRESSION_BACKEND_FIELD_NUMBER`
`static int`	`RANKING_EXPRESSION_FIELD_NUMBER`
`static int`	`RELEVANCE_SCORE_SPEC_FIELD_NUMBER`
`static int`	`RELEVANCE_THRESHOLD_FIELD_NUMBER`
`static int`	`SAFE_SEARCH_FIELD_NUMBER`
`static int`	`SEARCH_AS_YOU_TYPE_SPEC_FIELD_NUMBER`
`static int`	`SERVING_CONFIG_FIELD_NUMBER`
`static int`	`SESSION_FIELD_NUMBER`
`static int`	`SESSION_SPEC_FIELD_NUMBER`
`static int`	`SPELL_CORRECTION_SPEC_FIELD_NUMBER`
`static int`	`USER_INFO_FIELD_NUMBER`
`static int`	`USER_LABELS_FIELD_NUMBER`
`static int`	`USER_PSEUDO_ID_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`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
`boolean`	`equals(Object obj)`
`SearchRequest.BoostSpec`	`getBoostSpec()` 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.ContentSearchSpecOrBuilder`	`getContentSearchSpecOrBuilder()` A specification for configuring the behavior of content search.
`SearchRequest.CrowdingSpec`	`getCrowdingSpecs(int index)` 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.
`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.
`static SearchRequest`	`getDefaultInstance()`
`SearchRequest`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`SearchRequest.DisplaySpec`	`getDisplaySpec()` Optional.
`SearchRequest.DisplaySpecOrBuilder`	`getDisplaySpecOrBuilder()` Optional.
`SearchRequest.FacetSpec`	`getFacetSpecs(int index)` 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.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".
`SearchRequest.NaturalLanguageQueryUnderstandingSpec`	`getNaturalLanguageQueryUnderstandingSpec()` 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.
`com.google.protobuf.Parser<SearchRequest>`	`getParserForType()`
`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.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.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.SearchAsYouTypeSpecOrBuilder`	`getSearchAsYouTypeSpecOrBuilder()` Search as you type configuration.
`int`	`getSerializedSize()`
`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.SessionSpecOrBuilder`	`getSessionSpecOrBuilder()` Session specification.
`SearchRequest.SpellCorrectionSpec`	`getSpellCorrectionSpec()` 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.
`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.
`int`	`hashCode()`
`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)`
`boolean`	`isInitialized()`
`static SearchRequest.Builder`	`newBuilder()`
`static SearchRequest.Builder`	`newBuilder(SearchRequest prototype)`
`SearchRequest.Builder`	`newBuilderForType()`
`protected SearchRequest.Builder`	`newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)`
`static SearchRequest`	`parseDelimitedFrom(InputStream input)`
`static SearchRequest`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static SearchRequest`	`parseFrom(byte[] data)`
`static SearchRequest`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static SearchRequest`	`parseFrom(ByteBuffer data)`
`static SearchRequest`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static SearchRequest`	`parseFrom(com.google.protobuf.ByteString data)`
`static SearchRequest`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static SearchRequest`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static SearchRequest`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static SearchRequest`	`parseFrom(InputStream input)`
`static SearchRequest`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<SearchRequest>`	`parser()`
`SearchRequest.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- SERVING_CONFIG_FIELD_NUMBER
```
public static final int SERVING_CONFIG_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- BRANCH_FIELD_NUMBER
```
public static final int BRANCH_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- QUERY_FIELD_NUMBER
```
public static final int QUERY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PAGE_CATEGORIES_FIELD_NUMBER
```
public static final int PAGE_CATEGORIES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- IMAGE_QUERY_FIELD_NUMBER
```
public static final int IMAGE_QUERY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PAGE_SIZE_FIELD_NUMBER
```
public static final int PAGE_SIZE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PAGE_TOKEN_FIELD_NUMBER
```
public static final int PAGE_TOKEN_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- OFFSET_FIELD_NUMBER
```
public static final int OFFSET_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ONE_BOX_PAGE_SIZE_FIELD_NUMBER
```
public static final int ONE_BOX_PAGE_SIZE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DATA_STORE_SPECS_FIELD_NUMBER
```
public static final int DATA_STORE_SPECS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- FILTER_FIELD_NUMBER
```
public static final int FILTER_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CANONICAL_FILTER_FIELD_NUMBER
```
public static final int CANONICAL_FILTER_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ORDER_BY_FIELD_NUMBER
```
public static final int ORDER_BY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- USER_INFO_FIELD_NUMBER
```
public static final int USER_INFO_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LANGUAGE_CODE_FIELD_NUMBER
```
public static final int LANGUAGE_CODE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- FACET_SPECS_FIELD_NUMBER
```
public static final int FACET_SPECS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- BOOST_SPEC_FIELD_NUMBER
```
public static final int BOOST_SPEC_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PARAMS_FIELD_NUMBER
```
public static final int PARAMS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- QUERY_EXPANSION_SPEC_FIELD_NUMBER
```
public static final int QUERY_EXPANSION_SPEC_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SPELL_CORRECTION_SPEC_FIELD_NUMBER
```
public static final int SPELL_CORRECTION_SPEC_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- USER_PSEUDO_ID_FIELD_NUMBER
```
public static final int USER_PSEUDO_ID_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CONTENT_SEARCH_SPEC_FIELD_NUMBER
```
public static final int CONTENT_SEARCH_SPEC_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- RANKING_EXPRESSION_FIELD_NUMBER
```
public static final int RANKING_EXPRESSION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- RANKING_EXPRESSION_BACKEND_FIELD_NUMBER
```
public static final int RANKING_EXPRESSION_BACKEND_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SAFE_SEARCH_FIELD_NUMBER
```
public static final int SAFE_SEARCH_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- USER_LABELS_FIELD_NUMBER
```
public static final int USER_LABELS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- NATURAL_LANGUAGE_QUERY_UNDERSTANDING_SPEC_FIELD_NUMBER
```
public static final int NATURAL_LANGUAGE_QUERY_UNDERSTANDING_SPEC_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SEARCH_AS_YOU_TYPE_SPEC_FIELD_NUMBER
```
public static final int SEARCH_AS_YOU_TYPE_SPEC_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DISPLAY_SPEC_FIELD_NUMBER
```
public static final int DISPLAY_SPEC_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CROWDING_SPECS_FIELD_NUMBER
```
public static final int CROWDING_SPECS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SESSION_FIELD_NUMBER
```
public static final int SESSION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SESSION_SPEC_FIELD_NUMBER
```
public static final int SESSION_SPEC_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- RELEVANCE_THRESHOLD_FIELD_NUMBER
```
public static final int RELEVANCE_THRESHOLD_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- RELEVANCE_SCORE_SPEC_FIELD_NUMBER
```
public static final int RELEVANCE_SCORE_SPEC_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

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

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

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

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

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

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

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.

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.

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.

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.

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.