SearchRequest (proto-google-cloud-discoveryengine-v1beta 0.29.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.discoveryengine.v1beta.SearchRequest

All Implemented Interfaces:

SearchRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
```
public final class SearchRequest
extends com.google.protobuf.GeneratedMessageV3
implements SearchRequestOrBuilder
```
```
 Request message for
 [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
 method.
 
```
Protobuf type google.cloud.discoveryengine.v1beta.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.v1beta.SearchService.Search] method.
`static class`	`SearchRequest.ContentSearchSpec` A specification for configuring the behavior of content search.
`static interface`	`SearchRequest.ContentSearchSpecOrBuilder`
`static class`	`SearchRequest.EmbeddingSpec` The specification that uses customized query embedding vector to do semantic document retrieval.
`static interface`	`SearchRequest.EmbeddingSpecOrBuilder`
`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.QueryExpansionSpec` Specification to determine under which conditions query expansion should occur.
`static interface`	`SearchRequest.QueryExpansionSpecOrBuilder`
`static class`	`SearchRequest.SpellCorrectionSpec` The specification for query spell correction.
`static interface`	`SearchRequest.SpellCorrectionSpecOrBuilder`

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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`	`CONTENT_SEARCH_SPEC_FIELD_NUMBER`
`static int`	`EMBEDDING_SPEC_FIELD_NUMBER`
`static int`	`FACET_SPECS_FIELD_NUMBER`
`static int`	`FILTER_FIELD_NUMBER`
`static int`	`IMAGE_QUERY_FIELD_NUMBER`
`static int`	`OFFSET_FIELD_NUMBER`
`static int`	`ORDER_BY_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_FIELD_NUMBER`
`static int`	`SAFE_SEARCH_FIELD_NUMBER`
`static int`	`SERVING_CONFIG_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.GeneratedMessageV3
alwaysUseFieldBuilders, 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`.
`SearchRequest.ContentSearchSpec`	`getContentSearchSpec()` A specification for configuring the behavior of content search.
`SearchRequest.ContentSearchSpecOrBuilder`	`getContentSearchSpecOrBuilder()` A specification for configuring the behavior of content search.
`static SearchRequest`	`getDefaultInstance()`
`SearchRequest`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`SearchRequest.EmbeddingSpec`	`getEmbeddingSpec()` Uses the provided embedding to do additional semantic document retrieval.
`SearchRequest.EmbeddingSpecOrBuilder`	`getEmbeddingSpecOrBuilder()` Uses the provided embedding to do additional semantic document retrieval.
`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.
`int`	`getOffset()` A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the [Document][google.cloud.discoveryengine.v1beta.Document]s deemed by the API as relevant) in search results.
`String`	`getOrderBy()` The order in which documents are returned.
`com.google.protobuf.ByteString`	`getOrderByBytes()` The order in which documents are returned.
`int`	`getPageSize()` Maximum number of [Document][google.cloud.discoveryengine.v1beta.Document]s to return.
`String`	`getPageToken()` A page token received from a previous [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search] call.
`com.google.protobuf.ByteString`	`getPageTokenBytes()` A page token received from a previous [SearchService.Search][google.cloud.discoveryengine.v1beta.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()` The ranking expression controls the customized ranking on retrieval documents.
`com.google.protobuf.ByteString`	`getRankingExpressionBytes()` The ranking expression controls the customized ranking on retrieval documents.
`boolean`	`getSafeSearch()` Whether to turn on safe search.
`int`	`getSerializedSize()`
`String`	`getServingConfig()` Required.
`com.google.protobuf.ByteString`	`getServingConfigBytes()` Required.
`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()` A unique identifier for tracking visitors.
`com.google.protobuf.ByteString`	`getUserPseudoIdBytes()` A unique identifier for tracking visitors.
`boolean`	`hasBoostSpec()` Boost specification to boost certain documents.
`boolean`	`hasContentSearchSpec()` A specification for configuring the behavior of content search.
`boolean`	`hasEmbeddingSpec()` Uses the provided embedding to do additional semantic document retrieval.
`int`	`hashCode()`
`boolean`	`hasImageQuery()` Raw image query.
`boolean`	`hasQueryExpansionSpec()` The query expansion specification that specifies the conditions under which query expansion occurs.
`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.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapField`	`internalGetMapField(int number)`
`boolean`	`isInitialized()`
`static SearchRequest.Builder`	`newBuilder()`
`static SearchRequest.Builder`	`newBuilder(SearchRequest prototype)`
`SearchRequest.Builder`	`newBuilderForType()`
`protected SearchRequest.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`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.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, 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
- 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
- FILTER_FIELD_NUMBER
```
public static final int 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
- 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
- EMBEDDING_SPEC_FIELD_NUMBER
```
public static final int EMBEDDING_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
- 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

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

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

internalGetMapField
```
protected com.google.protobuf.MapField internalGetMapField(int number)
```
Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

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

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getServingConfig

public String getServingConfig()

 Required. The resource name of the Search serving config, such as
 `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/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.

hasImageQuery
```
public boolean hasImageQuery()
```
```
 Raw image query.
 
```
.google.cloud.discoveryengine.v1beta.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.v1beta.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.v1beta.SearchRequest.ImageQuery image_query = 19;
Specified by:

getImageQueryOrBuilder in interface SearchRequestOrBuilder

getPageSize

public int getPageSize()

 Maximum number of [Document][google.cloud.discoveryengine.v1beta.Document]s
 to return. If unspecified, defaults to a reasonable value. The maximum
 allowed value is 100. Values above 100 are coerced to 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.v1beta.SearchService.Search]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [SearchService.Search][google.cloud.discoveryengine.v1beta.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.v1beta.SearchService.Search]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [SearchService.Search][google.cloud.discoveryengine.v1beta.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.v1beta.Document]s deemed by the API
 as relevant) in search results. This field is only considered if
 [page_token][google.cloud.discoveryengine.v1beta.SearchRequest.page_token]
 is unset.

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

int32 offset = 6;

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

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.

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.

string filter = 7;

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

getOrderBy

public String getOrderBy()

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

 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.v1beta.Document]
 object. Leave it unset if ordered by relevance. `order_by` expression is
 case-sensitive.

 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.
 [UserInfo.user_agent][google.cloud.discoveryengine.v1beta.UserInfo.user_agent]
 is used to deduce `device_type` for analytics.

.google.cloud.discoveryengine.v1beta.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.
 [UserInfo.user_agent][google.cloud.discoveryengine.v1beta.UserInfo.user_agent]
 is used to deduce `device_type` for analytics.

.google.cloud.discoveryengine.v1beta.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.
 [UserInfo.user_agent][google.cloud.discoveryengine.v1beta.UserInfo.user_agent]
 is used to deduce `device_type` for analytics.

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

Specified by:: getUserInfoOrBuilder in interface SearchRequestOrBuilder

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.v1beta.SearchRequest.FacetSpec facet_specs = 9;

Specified by:: getFacetSpecsList 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.v1beta.SearchRequest.FacetSpec facet_specs = 9;

Specified by:: getFacetSpecsOrBuilderList 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.v1beta.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.v1beta.SearchRequest.FacetSpec facet_specs = 9;

Specified by:: getFacetSpecs in interface SearchRequestOrBuilder

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.v1beta.SearchRequest.FacetSpec facet_specs = 9;

Specified by:: getFacetSpecsOrBuilder in interface SearchRequestOrBuilder

hasBoostSpec
```
public boolean hasBoostSpec()
```
```
 Boost specification to boost certain documents.
 
```
.google.cloud.discoveryengine.v1beta.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.
 
```
.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 10;
Specified by:

getBoostSpec in interface SearchRequestOrBuilder

Returns:

The boostSpec.

getBoostSpecOrBuilder
```
public SearchRequest.BoostSpecOrBuilder getBoostSpecOrBuilder()
```
```
 Boost specification to boost certain documents.
 
```
.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 10;
Specified by:

getBoostSpecOrBuilder in interface SearchRequestOrBuilder