SearchRequest.Builder (proto-google-cloud-retail-v2 2.34.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>
    - - com.google.cloud.retail.v2.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.GeneratedMessageV3.Builder<SearchRequest.Builder>
implements SearchRequestOrBuilder
```
```
 Request message for
 [SearchService.Search][google.cloud.retail.v2.SearchService.Search] method.
 
```
Protobuf type google.cloud.retail.v2.SearchRequest

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`SearchRequest.Builder`	`addAllFacetSpecs(Iterable<? extends SearchRequest.FacetSpec> values)` Facet specifications for faceted search.
`SearchRequest.Builder`	`addAllPageCategories(Iterable<String> values)` The categories associated with a category page.
`SearchRequest.Builder`	`addAllVariantRollupKeys(Iterable<String> values)` The keys to fetch and rollup the matching [variant][google.cloud.retail.v2.Product.Type.VARIANT] [Product][google.cloud.retail.v2.Product]s attributes, [FulfillmentInfo][google.cloud.retail.v2.FulfillmentInfo] or [LocalInventory][google.cloud.retail.v2.LocalInventory]s attributes.
`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)` The categories associated with a category page.
`SearchRequest.Builder`	`addPageCategoriesBytes(com.google.protobuf.ByteString value)` The categories associated with a category page.
`SearchRequest.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`SearchRequest.Builder`	`addVariantRollupKeys(String value)` The keys to fetch and rollup the matching [variant][google.cloud.retail.v2.Product.Type.VARIANT] [Product][google.cloud.retail.v2.Product]s attributes, [FulfillmentInfo][google.cloud.retail.v2.FulfillmentInfo] or [LocalInventory][google.cloud.retail.v2.LocalInventory]s attributes.
`SearchRequest.Builder`	`addVariantRollupKeysBytes(com.google.protobuf.ByteString value)` The keys to fetch and rollup the matching [variant][google.cloud.retail.v2.Product.Type.VARIANT] [Product][google.cloud.retail.v2.Product]s attributes, [FulfillmentInfo][google.cloud.retail.v2.FulfillmentInfo] or [LocalInventory][google.cloud.retail.v2.LocalInventory]s attributes.
`SearchRequest`	`build()`
`SearchRequest`	`buildPartial()`
`SearchRequest.Builder`	`clear()`
`SearchRequest.Builder`	`clearBoostSpec()` Boost specification to boost certain products.
`SearchRequest.Builder`	`clearBranch()` The branch resource name, such as `projects/*/locations/global/catalogs/default_catalog/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`	`clearDynamicFacetSpec()` Deprecated.
`SearchRequest.Builder`	`clearEntity()` The entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc.
`SearchRequest.Builder`	`clearFacetSpecs()` Facet specifications for faceted search.
`SearchRequest.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`SearchRequest.Builder`	`clearFilter()` The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered.
`SearchRequest.Builder`	`clearLabels()`
`SearchRequest.Builder`	`clearOffset()` A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the [Product][google.cloud.retail.v2.Product]s deemed by the API as relevant) in search results.
`SearchRequest.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`SearchRequest.Builder`	`clearOrderBy()` The order in which products are returned.
`SearchRequest.Builder`	`clearPageCategories()` The categories associated with a category page.
`SearchRequest.Builder`	`clearPageSize()` Maximum number of [Product][google.cloud.retail.v2.Product]s to return.
`SearchRequest.Builder`	`clearPageToken()` A page token [SearchResponse.next_page_token][google.cloud.retail.v2.SearchResponse.next_page_token], received from a previous [SearchService.Search][google.cloud.retail.v2.SearchService.Search] call.
`SearchRequest.Builder`	`clearPersonalizationSpec()` The specification for personalization.
`SearchRequest.Builder`	`clearPlacement()` Required.
`SearchRequest.Builder`	`clearQuery()` Raw search query.
`SearchRequest.Builder`	`clearQueryExpansionSpec()` The query expansion specification that specifies the conditions under which query expansion will occur.
`SearchRequest.Builder`	`clearSearchMode()` The search mode of the search request.
`SearchRequest.Builder`	`clearSpellCorrectionSpec()` The spell correction specification that specifies the mode under which spell correction will take effect.
`SearchRequest.Builder`	`clearUserInfo()` User information.
`SearchRequest.Builder`	`clearVariantRollupKeys()` The keys to fetch and rollup the matching [variant][google.cloud.retail.v2.Product.Type.VARIANT] [Product][google.cloud.retail.v2.Product]s attributes, [FulfillmentInfo][google.cloud.retail.v2.FulfillmentInfo] or [LocalInventory][google.cloud.retail.v2.LocalInventory]s attributes.
`SearchRequest.Builder`	`clearVisitorId()` Required.
`SearchRequest.Builder`	`clone()`
`boolean`	`containsLabels(String key)` The 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 products.
`SearchRequest.BoostSpec.Builder`	`getBoostSpecBuilder()` Boost specification to boost certain products.
`SearchRequest.BoostSpecOrBuilder`	`getBoostSpecOrBuilder()` Boost specification to boost certain products.
`String`	`getBranch()` The branch resource name, such as `projects/*/locations/global/catalogs/default_catalog/branches/0`.
`com.google.protobuf.ByteString`	`getBranchBytes()` The branch resource name, such as `projects/*/locations/global/catalogs/default_catalog/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`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`SearchRequest.DynamicFacetSpec`	`getDynamicFacetSpec()` Deprecated. google.cloud.retail.v2.SearchRequest.dynamic_facet_spec is deprecated. See google/cloud/retail/v2/search_service.proto;l=596
`SearchRequest.DynamicFacetSpec.Builder`	`getDynamicFacetSpecBuilder()` Deprecated.
`SearchRequest.DynamicFacetSpecOrBuilder`	`getDynamicFacetSpecOrBuilder()` Deprecated.
`String`	`getEntity()` The entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc.
`com.google.protobuf.ByteString`	`getEntityBytes()` The entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc.
`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 products 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 products being filtered.
`Map<String,String>`	`getLabels()` Deprecated.
`int`	`getLabelsCount()` The 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>`	`getLabelsMap()` The labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64.
`String`	`getLabelsOrDefault(String key, String defaultValue)` The labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64.
`String`	`getLabelsOrThrow(String key)` The 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>`	`getMutableLabels()` Deprecated.
`int`	`getOffset()` A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the [Product][google.cloud.retail.v2.Product]s deemed by the API as relevant) in search results.
`String`	`getOrderBy()` The order in which products are returned.
`com.google.protobuf.ByteString`	`getOrderByBytes()` The order in which products are returned.
`String`	`getPageCategories(int index)` The categories associated with a category page.
`com.google.protobuf.ByteString`	`getPageCategoriesBytes(int index)` The categories associated with a category page.
`int`	`getPageCategoriesCount()` The categories associated with a category page.
`com.google.protobuf.ProtocolStringList`	`getPageCategoriesList()` The categories associated with a category page.
`int`	`getPageSize()` Maximum number of [Product][google.cloud.retail.v2.Product]s to return.
`String`	`getPageToken()` A page token [SearchResponse.next_page_token][google.cloud.retail.v2.SearchResponse.next_page_token], received from a previous [SearchService.Search][google.cloud.retail.v2.SearchService.Search] call.
`com.google.protobuf.ByteString`	`getPageTokenBytes()` A page token [SearchResponse.next_page_token][google.cloud.retail.v2.SearchResponse.next_page_token], received from a previous [SearchService.Search][google.cloud.retail.v2.SearchService.Search] call.
`SearchRequest.PersonalizationSpec`	`getPersonalizationSpec()` The specification for personalization.
`SearchRequest.PersonalizationSpec.Builder`	`getPersonalizationSpecBuilder()` The specification for personalization.
`SearchRequest.PersonalizationSpecOrBuilder`	`getPersonalizationSpecOrBuilder()` The specification for personalization.
`String`	`getPlacement()` Required.
`com.google.protobuf.ByteString`	`getPlacementBytes()` Required.
`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 will occur.
`SearchRequest.QueryExpansionSpec.Builder`	`getQueryExpansionSpecBuilder()` The query expansion specification that specifies the conditions under which query expansion will occur.
`SearchRequest.QueryExpansionSpecOrBuilder`	`getQueryExpansionSpecOrBuilder()` The query expansion specification that specifies the conditions under which query expansion will occur.
`SearchRequest.SearchMode`	`getSearchMode()` The search mode of the search request.
`int`	`getSearchModeValue()` The search mode of the search request.
`SearchRequest.SpellCorrectionSpec`	`getSpellCorrectionSpec()` The spell correction specification that specifies the mode under which spell correction will take effect.
`SearchRequest.SpellCorrectionSpec.Builder`	`getSpellCorrectionSpecBuilder()` The spell correction specification that specifies the mode under which spell correction will take effect.
`SearchRequest.SpellCorrectionSpecOrBuilder`	`getSpellCorrectionSpecOrBuilder()` The spell correction specification that specifies the mode under which spell correction will take effect.
`UserInfo`	`getUserInfo()` User information.
`UserInfo.Builder`	`getUserInfoBuilder()` User information.
`UserInfoOrBuilder`	`getUserInfoOrBuilder()` User information.
`String`	`getVariantRollupKeys(int index)` The keys to fetch and rollup the matching [variant][google.cloud.retail.v2.Product.Type.VARIANT] [Product][google.cloud.retail.v2.Product]s attributes, [FulfillmentInfo][google.cloud.retail.v2.FulfillmentInfo] or [LocalInventory][google.cloud.retail.v2.LocalInventory]s attributes.
`com.google.protobuf.ByteString`	`getVariantRollupKeysBytes(int index)` The keys to fetch and rollup the matching [variant][google.cloud.retail.v2.Product.Type.VARIANT] [Product][google.cloud.retail.v2.Product]s attributes, [FulfillmentInfo][google.cloud.retail.v2.FulfillmentInfo] or [LocalInventory][google.cloud.retail.v2.LocalInventory]s attributes.
`int`	`getVariantRollupKeysCount()` The keys to fetch and rollup the matching [variant][google.cloud.retail.v2.Product.Type.VARIANT] [Product][google.cloud.retail.v2.Product]s attributes, [FulfillmentInfo][google.cloud.retail.v2.FulfillmentInfo] or [LocalInventory][google.cloud.retail.v2.LocalInventory]s attributes.
`com.google.protobuf.ProtocolStringList`	`getVariantRollupKeysList()` The keys to fetch and rollup the matching [variant][google.cloud.retail.v2.Product.Type.VARIANT] [Product][google.cloud.retail.v2.Product]s attributes, [FulfillmentInfo][google.cloud.retail.v2.FulfillmentInfo] or [LocalInventory][google.cloud.retail.v2.LocalInventory]s attributes.
`String`	`getVisitorId()` Required.
`com.google.protobuf.ByteString`	`getVisitorIdBytes()` Required.
`boolean`	`hasBoostSpec()` Boost specification to boost certain products.
`boolean`	`hasDynamicFacetSpec()` Deprecated. google.cloud.retail.v2.SearchRequest.dynamic_facet_spec is deprecated. See google/cloud/retail/v2/search_service.proto;l=596
`boolean`	`hasPersonalizationSpec()` The specification for personalization.
`boolean`	`hasQueryExpansionSpec()` The query expansion specification that specifies the conditions under which query expansion will occur.
`boolean`	`hasSpellCorrectionSpec()` The spell correction specification that specifies the mode under which spell correction will take effect.
`boolean`	`hasUserInfo()` User information.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapField`	`internalGetMapField(int number)`
`protected com.google.protobuf.MapField`	`internalGetMutableMapField(int number)`
`boolean`	`isInitialized()`
`SearchRequest.Builder`	`mergeBoostSpec(SearchRequest.BoostSpec value)` Boost specification to boost certain products.
`SearchRequest.Builder`	`mergeDynamicFacetSpec(SearchRequest.DynamicFacetSpec value)` Deprecated.
`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`	`mergePersonalizationSpec(SearchRequest.PersonalizationSpec value)` The specification for personalization.
`SearchRequest.Builder`	`mergeQueryExpansionSpec(SearchRequest.QueryExpansionSpec value)` The query expansion specification that specifies the conditions under which query expansion will occur.
`SearchRequest.Builder`	`mergeSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec value)` The spell correction specification that specifies the mode under which spell correction will take effect.
`SearchRequest.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`SearchRequest.Builder`	`mergeUserInfo(UserInfo value)` User information.
`SearchRequest.Builder`	`putAllLabels(Map<String,String> values)` The labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64.
`SearchRequest.Builder`	`putLabels(String key, String value)` The labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64.
`SearchRequest.Builder`	`removeFacetSpecs(int index)` Facet specifications for faceted search.
`SearchRequest.Builder`	`removeLabels(String key)` The 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 products.
`SearchRequest.Builder`	`setBoostSpec(SearchRequest.BoostSpec value)` Boost specification to boost certain products.
`SearchRequest.Builder`	`setBranch(String value)` The branch resource name, such as `projects/*/locations/global/catalogs/default_catalog/branches/0`.
`SearchRequest.Builder`	`setBranchBytes(com.google.protobuf.ByteString value)` The branch resource name, such as `projects/*/locations/global/catalogs/default_catalog/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`	`setDynamicFacetSpec(SearchRequest.DynamicFacetSpec.Builder builderForValue)` Deprecated.
`SearchRequest.Builder`	`setDynamicFacetSpec(SearchRequest.DynamicFacetSpec value)` Deprecated.
`SearchRequest.Builder`	`setEntity(String value)` The entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc.
`SearchRequest.Builder`	`setEntityBytes(com.google.protobuf.ByteString value)` The entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc.
`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`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`SearchRequest.Builder`	`setFilter(String value)` The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products 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 products being filtered.
`SearchRequest.Builder`	`setOffset(int value)` A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the [Product][google.cloud.retail.v2.Product]s deemed by the API as relevant) in search results.
`SearchRequest.Builder`	`setOrderBy(String value)` The order in which products are returned.
`SearchRequest.Builder`	`setOrderByBytes(com.google.protobuf.ByteString value)` The order in which products are returned.
`SearchRequest.Builder`	`setPageCategories(int index, String value)` The categories associated with a category page.
`SearchRequest.Builder`	`setPageSize(int value)` Maximum number of [Product][google.cloud.retail.v2.Product]s to return.
`SearchRequest.Builder`	`setPageToken(String value)` A page token [SearchResponse.next_page_token][google.cloud.retail.v2.SearchResponse.next_page_token], received from a previous [SearchService.Search][google.cloud.retail.v2.SearchService.Search] call.
`SearchRequest.Builder`	`setPageTokenBytes(com.google.protobuf.ByteString value)` A page token [SearchResponse.next_page_token][google.cloud.retail.v2.SearchResponse.next_page_token], received from a previous [SearchService.Search][google.cloud.retail.v2.SearchService.Search] call.
`SearchRequest.Builder`	`setPersonalizationSpec(SearchRequest.PersonalizationSpec.Builder builderForValue)` The specification for personalization.
`SearchRequest.Builder`	`setPersonalizationSpec(SearchRequest.PersonalizationSpec value)` The specification for personalization.
`SearchRequest.Builder`	`setPlacement(String value)` Required.
`SearchRequest.Builder`	`setPlacementBytes(com.google.protobuf.ByteString value)` Required.
`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 will occur.
`SearchRequest.Builder`	`setQueryExpansionSpec(SearchRequest.QueryExpansionSpec value)` The query expansion specification that specifies the conditions under which query expansion will occur.
`SearchRequest.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`SearchRequest.Builder`	`setSearchMode(SearchRequest.SearchMode value)` The search mode of the search request.
`SearchRequest.Builder`	`setSearchModeValue(int value)` The search mode of the search request.
`SearchRequest.Builder`	`setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec.Builder builderForValue)` The spell correction specification that specifies the mode under which spell correction will take effect.
`SearchRequest.Builder`	`setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec value)` The spell correction specification that specifies the mode under which spell correction will take effect.
`SearchRequest.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`SearchRequest.Builder`	`setUserInfo(UserInfo.Builder builderForValue)` User information.
`SearchRequest.Builder`	`setUserInfo(UserInfo value)` User information.
`SearchRequest.Builder`	`setVariantRollupKeys(int index, String value)` The keys to fetch and rollup the matching [variant][google.cloud.retail.v2.Product.Type.VARIANT] [Product][google.cloud.retail.v2.Product]s attributes, [FulfillmentInfo][google.cloud.retail.v2.FulfillmentInfo] or [LocalInventory][google.cloud.retail.v2.LocalInventory]s attributes.
`SearchRequest.Builder`	`setVisitorId(String value)` Required.
`SearchRequest.Builder`	`setVisitorIdBytes(com.google.protobuf.ByteString value)` Required.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapFieldReflection, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, 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

Method Detail

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.Builder<SearchRequest.Builder>

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

internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>

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

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.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.GeneratedMessageV3.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.GeneratedMessageV3.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

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

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

Specified by:

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

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>

setField

public SearchRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                      Object value)

Specified by:: setField in interface com.google.protobuf.Message.Builder
Overrides:: setField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>

clearField
```
public SearchRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
Specified by:

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

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>

clearOneof
```
public SearchRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
Specified by:

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

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>

setRepeatedField

public SearchRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              int index,
                                              Object value)

Specified by:: setRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>

addRepeatedField

public SearchRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              Object value)

Specified by:: addRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.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.GeneratedMessageV3.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

getPlacement

public String getPlacement()

 Required. The resource name of the Retail Search serving config, such as
 `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config`
 or the name of the legacy placement resource, such as
 `projects/*/locations/global/catalogs/default_catalog/placements/default_search`.
 This field is used to identify the serving config name and the set
 of models that will be used to make the search.

string placement = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:: getPlacement in interface SearchRequestOrBuilder
Returns:: The placement.

getPlacementBytes

public com.google.protobuf.ByteString getPlacementBytes()

 Required. The resource name of the Retail Search serving config, such as
 `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config`
 or the name of the legacy placement resource, such as
 `projects/*/locations/global/catalogs/default_catalog/placements/default_search`.
 This field is used to identify the serving config name and the set
 of models that will be used to make the search.

string placement = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:: getPlacementBytes in interface SearchRequestOrBuilder
Returns:: The bytes for placement.

setPlacement

public SearchRequest.Builder setPlacement(String value)

 Required. The resource name of the Retail Search serving config, such as
 `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config`
 or the name of the legacy placement resource, such as
 `projects/*/locations/global/catalogs/default_catalog/placements/default_search`.
 This field is used to identify the serving config name and the set
 of models that will be used to make the search.

string placement = 1 [(.google.api.field_behavior) = REQUIRED];

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

clearPlacement

public SearchRequest.Builder clearPlacement()

 Required. The resource name of the Retail Search serving config, such as
 `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config`
 or the name of the legacy placement resource, such as
 `projects/*/locations/global/catalogs/default_catalog/placements/default_search`.
 This field is used to identify the serving config name and the set
 of models that will be used to make the search.

string placement = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:: This builder for chaining.

setPlacementBytes

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

 Required. The resource name of the Retail Search serving config, such as
 `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config`
 or the name of the legacy placement resource, such as
 `projects/*/locations/global/catalogs/default_catalog/placements/default_search`.
 This field is used to identify the serving config name and the set
 of models that will be used to make the search.

string placement = 1 [(.google.api.field_behavior) = REQUIRED];

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

getBranch

public String getBranch()

 The branch resource name, such as
 `projects/*/locations/global/catalogs/default_catalog/branches/0`.

 Use "default_branch" as the branch ID or leave this field empty, to search
 products 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/catalogs/default_catalog/branches/0`.

 Use "default_branch" as the branch ID or leave this field empty, to search
 products 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/catalogs/default_catalog/branches/0`.

 Use "default_branch" as the branch ID or leave this field empty, to search
 products 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/catalogs/default_catalog/branches/0`.

 Use "default_branch" as the branch ID or leave this field empty, to search
 products 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/catalogs/default_catalog/branches/0`.

 Use "default_branch" as the branch ID or leave this field empty, to search
 products 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.

 If this field is empty, the request is considered a category browsing
 request and returned results are based on
 [filter][google.cloud.retail.v2.SearchRequest.filter] and
 [page_categories][google.cloud.retail.v2.SearchRequest.page_categories].

string query = 3;

Specified by:: getQuery in interface SearchRequestOrBuilder
Returns:: The query.

getQueryBytes

public com.google.protobuf.ByteString getQueryBytes()

 Raw search query.

 If this field is empty, the request is considered a category browsing
 request and returned results are based on
 [filter][google.cloud.retail.v2.SearchRequest.filter] and
 [page_categories][google.cloud.retail.v2.SearchRequest.page_categories].

string query = 3;

Specified by:: getQueryBytes in interface SearchRequestOrBuilder
Returns:: The bytes for query.

setQuery

public SearchRequest.Builder setQuery(String value)

 Raw search query.

 If this field is empty, the request is considered a category browsing
 request and returned results are based on
 [filter][google.cloud.retail.v2.SearchRequest.filter] and
 [page_categories][google.cloud.retail.v2.SearchRequest.page_categories].

string query = 3;

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

clearQuery

public SearchRequest.Builder clearQuery()

 Raw search query.

 If this field is empty, the request is considered a category browsing
 request and returned results are based on
 [filter][google.cloud.retail.v2.SearchRequest.filter] and
 [page_categories][google.cloud.retail.v2.SearchRequest.page_categories].

string query = 3;

Returns:: This builder for chaining.

setQueryBytes

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

 Raw search query.

 If this field is empty, the request is considered a category browsing
 request and returned results are based on
 [filter][google.cloud.retail.v2.SearchRequest.filter] and
 [page_categories][google.cloud.retail.v2.SearchRequest.page_categories].

string query = 3;

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

getVisitorId

public String getVisitorId()

 Required. 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 should be the same identifier as
 [UserEvent.visitor_id][google.cloud.retail.v2.UserEvent.visitor_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 visitor_id = 4 [(.google.api.field_behavior) = REQUIRED];

Specified by:: getVisitorId in interface SearchRequestOrBuilder
Returns:: The visitorId.

getVisitorIdBytes

public com.google.protobuf.ByteString getVisitorIdBytes()

 Required. 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 should be the same identifier as
 [UserEvent.visitor_id][google.cloud.retail.v2.UserEvent.visitor_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 visitor_id = 4 [(.google.api.field_behavior) = REQUIRED];

Specified by:: getVisitorIdBytes in interface SearchRequestOrBuilder
Returns:: The bytes for visitorId.

setVisitorId

public SearchRequest.Builder setVisitorId(String value)

 Required. 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 should be the same identifier as
 [UserEvent.visitor_id][google.cloud.retail.v2.UserEvent.visitor_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 visitor_id = 4 [(.google.api.field_behavior) = REQUIRED];

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

clearVisitorId

public SearchRequest.Builder clearVisitorId()

 Required. 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 should be the same identifier as
 [UserEvent.visitor_id][google.cloud.retail.v2.UserEvent.visitor_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 visitor_id = 4 [(.google.api.field_behavior) = REQUIRED];

Returns:: This builder for chaining.

setVisitorIdBytes

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

 Required. 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 should be the same identifier as
 [UserEvent.visitor_id][google.cloud.retail.v2.UserEvent.visitor_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 visitor_id = 4 [(.google.api.field_behavior) = REQUIRED];

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

hasUserInfo
```
public boolean hasUserInfo()
```
```
 User information.
 
```
.google.cloud.retail.v2.UserInfo user_info = 5;
Specified by:

hasUserInfo in interface SearchRequestOrBuilder

Returns:

Whether the userInfo field is set.

getUserInfo
```
public UserInfo getUserInfo()
```
```
 User information.
 
```
.google.cloud.retail.v2.UserInfo user_info = 5;
Specified by:

getUserInfo in interface SearchRequestOrBuilder

Returns:

The userInfo.

setUserInfo

public SearchRequest.Builder setUserInfo(UserInfo value)

 User information.

.google.cloud.retail.v2.UserInfo user_info = 5;

setUserInfo

public SearchRequest.Builder setUserInfo(UserInfo.Builder builderForValue)

 User information.

.google.cloud.retail.v2.UserInfo user_info = 5;

mergeUserInfo

public SearchRequest.Builder mergeUserInfo(UserInfo value)

 User information.

.google.cloud.retail.v2.UserInfo user_info = 5;

clearUserInfo

public SearchRequest.Builder clearUserInfo()

 User information.

.google.cloud.retail.v2.UserInfo user_info = 5;

getUserInfoBuilder

public UserInfo.Builder getUserInfoBuilder()

 User information.

.google.cloud.retail.v2.UserInfo user_info = 5;

getUserInfoOrBuilder
```
public UserInfoOrBuilder getUserInfoOrBuilder()
```
```
 User information.
 
```
.google.cloud.retail.v2.UserInfo user_info = 5;
Specified by:

getUserInfoOrBuilder in interface SearchRequestOrBuilder

getPageSize

public int getPageSize()

 Maximum number of [Product][google.cloud.retail.v2.Product]s to return. If
 unspecified, defaults to a reasonable value. The maximum allowed value is
 120. Values above 120 will be coerced to 120.

 If this field is negative, an INVALID_ARGUMENT is returned.

int32 page_size = 7;

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

setPageSize

public SearchRequest.Builder setPageSize(int value)

 Maximum number of [Product][google.cloud.retail.v2.Product]s to return. If
 unspecified, defaults to a reasonable value. The maximum allowed value is
 120. Values above 120 will be coerced to 120.

 If this field is negative, an INVALID_ARGUMENT is returned.

int32 page_size = 7;

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

clearPageSize

public SearchRequest.Builder clearPageSize()

 Maximum number of [Product][google.cloud.retail.v2.Product]s to return. If
 unspecified, defaults to a reasonable value. The maximum allowed value is
 120. Values above 120 will be coerced to 120.

 If this field is negative, an INVALID_ARGUMENT is returned.

int32 page_size = 7;

Returns:: This builder for chaining.

getPageToken

public String getPageToken()

 A page token
 [SearchResponse.next_page_token][google.cloud.retail.v2.SearchResponse.next_page_token],
 received from a previous
 [SearchService.Search][google.cloud.retail.v2.SearchService.Search] call.
 Provide this to retrieve the subsequent page.

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

string page_token = 8;

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

getPageTokenBytes

public com.google.protobuf.ByteString getPageTokenBytes()

 A page token
 [SearchResponse.next_page_token][google.cloud.retail.v2.SearchResponse.next_page_token],
 received from a previous
 [SearchService.Search][google.cloud.retail.v2.SearchService.Search] call.
 Provide this to retrieve the subsequent page.

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

string page_token = 8;

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

setPageToken

public SearchRequest.Builder setPageToken(String value)

 A page token
 [SearchResponse.next_page_token][google.cloud.retail.v2.SearchResponse.next_page_token],
 received from a previous
 [SearchService.Search][google.cloud.retail.v2.SearchService.Search] call.
 Provide this to retrieve the subsequent page.

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

string page_token = 8;

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

clearPageToken

public SearchRequest.Builder clearPageToken()

 A page token
 [SearchResponse.next_page_token][google.cloud.retail.v2.SearchResponse.next_page_token],
 received from a previous
 [SearchService.Search][google.cloud.retail.v2.SearchService.Search] call.
 Provide this to retrieve the subsequent page.

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

string page_token = 8;

Returns:: This builder for chaining.

setPageTokenBytes

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

 A page token
 [SearchResponse.next_page_token][google.cloud.retail.v2.SearchResponse.next_page_token],
 received from a previous
 [SearchService.Search][google.cloud.retail.v2.SearchService.Search] call.
 Provide this to retrieve the subsequent page.

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

string page_token = 8;

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 [Product][google.cloud.retail.v2.Product]s
 deemed by the API as relevant) in search results. This field is only
 considered if [page_token][google.cloud.retail.v2.SearchRequest.page_token]
 is unset.

 If this field is negative, an INVALID_ARGUMENT is returned.

int32 offset = 9;

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 [Product][google.cloud.retail.v2.Product]s
 deemed by the API as relevant) in search results. This field is only
 considered if [page_token][google.cloud.retail.v2.SearchRequest.page_token]
 is unset.

 If this field is negative, an INVALID_ARGUMENT is returned.

int32 offset = 9;

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 [Product][google.cloud.retail.v2.Product]s
 deemed by the API as relevant) in search results. This field is only
 considered if [page_token][google.cloud.retail.v2.SearchRequest.page_token]
 is unset.

 If this field is negative, an INVALID_ARGUMENT is returned.

int32 offset = 9;

Returns:: This builder for chaining.

getFilter

public String getFilter()

 The filter syntax consists of an expression language for constructing a
 predicate from one or more fields of the products being filtered. Filter
 expression is case-sensitive. See more details at this [user
 guide](https://cloud.google.com/retail/docs/filter-and-order#filter).

 If this field is unrecognizable, an INVALID_ARGUMENT is returned.

string filter = 10;

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 products being filtered. Filter
 expression is case-sensitive. See more details at this [user
 guide](https://cloud.google.com/retail/docs/filter-and-order#filter).

 If this field is unrecognizable, an INVALID_ARGUMENT is returned.

string filter = 10;

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 products being filtered. Filter
 expression is case-sensitive. See more details at this [user
 guide](https://cloud.google.com/retail/docs/filter-and-order#filter).

 If this field is unrecognizable, an INVALID_ARGUMENT is returned.

string filter = 10;

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 products being filtered. Filter
 expression is case-sensitive. See more details at this [user
 guide](https://cloud.google.com/retail/docs/filter-and-order#filter).

 If this field is unrecognizable, an INVALID_ARGUMENT is returned.

string filter = 10;

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 products being filtered. Filter
 expression is case-sensitive. See more details at this [user
 guide](https://cloud.google.com/retail/docs/filter-and-order#filter).

 If this field is unrecognizable, an INVALID_ARGUMENT is returned.

string filter = 10;

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. For example, if a query does not have enough
 results, an expanded query with
 [SearchRequest.canonical_filter][google.cloud.retail.v2.SearchRequest.canonical_filter]
 will be returned as a supplement of the original query. This field is
 strongly recommended to achieve high search quality.

 See [SearchRequest.filter][google.cloud.retail.v2.SearchRequest.filter] for
 more details about filter syntax.

string canonical_filter = 28;

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. For example, if a query does not have enough
 results, an expanded query with
 [SearchRequest.canonical_filter][google.cloud.retail.v2.SearchRequest.canonical_filter]
 will be returned as a supplement of the original query. This field is
 strongly recommended to achieve high search quality.

 See [SearchRequest.filter][google.cloud.retail.v2.SearchRequest.filter] for
 more details about filter syntax.

string canonical_filter = 28;

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. For example, if a query does not have enough
 results, an expanded query with
 [SearchRequest.canonical_filter][google.cloud.retail.v2.SearchRequest.canonical_filter]
 will be returned as a supplement of the original query. This field is
 strongly recommended to achieve high search quality.

 See [SearchRequest.filter][google.cloud.retail.v2.SearchRequest.filter] for
 more details about filter syntax.

string canonical_filter = 28;

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. For example, if a query does not have enough
 results, an expanded query with
 [SearchRequest.canonical_filter][google.cloud.retail.v2.SearchRequest.canonical_filter]
 will be returned as a supplement of the original query. This field is
 strongly recommended to achieve high search quality.

 See [SearchRequest.filter][google.cloud.retail.v2.SearchRequest.filter] for
 more details about filter syntax.

string canonical_filter = 28;

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. For example, if a query does not have enough
 results, an expanded query with
 [SearchRequest.canonical_filter][google.cloud.retail.v2.SearchRequest.canonical_filter]
 will be returned as a supplement of the original query. This field is
 strongly recommended to achieve high search quality.

 See [SearchRequest.filter][google.cloud.retail.v2.SearchRequest.filter] for
 more details about filter syntax.

string canonical_filter = 28;

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

getOrderBy

public String getOrderBy()

 The order in which products are returned. Products can be ordered by
 a field in an [Product][google.cloud.retail.v2.Product] object. Leave it
 unset if ordered by relevance. OrderBy expression is case-sensitive. See
 more details at this [user
 guide](https://cloud.google.com/retail/docs/filter-and-order#order).

 If this field is unrecognizable, an INVALID_ARGUMENT is returned.

string order_by = 11;

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

getOrderByBytes

public com.google.protobuf.ByteString getOrderByBytes()

 The order in which products are returned. Products can be ordered by
 a field in an [Product][google.cloud.retail.v2.Product] object. Leave it
 unset if ordered by relevance. OrderBy expression is case-sensitive. See
 more details at this [user
 guide](https://cloud.google.com/retail/docs/filter-and-order#order).

 If this field is unrecognizable, an INVALID_ARGUMENT is returned.

string order_by = 11;

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

setOrderBy

public SearchRequest.Builder setOrderBy(String value)

 The order in which products are returned. Products can be ordered by
 a field in an [Product][google.cloud.retail.v2.Product] object. Leave it
 unset if ordered by relevance. OrderBy expression is case-sensitive. See
 more details at this [user
 guide](https://cloud.google.com/retail/docs/filter-and-order#order).

 If this field is unrecognizable, an INVALID_ARGUMENT is returned.

string order_by = 11;

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

clearOrderBy

public SearchRequest.Builder clearOrderBy()

 The order in which products are returned. Products can be ordered by
 a field in an [Product][google.cloud.retail.v2.Product] object. Leave it
 unset if ordered by relevance. OrderBy expression is case-sensitive. See
 more details at this [user
 guide](https://cloud.google.com/retail/docs/filter-and-order#order).

 If this field is unrecognizable, an INVALID_ARGUMENT is returned.

string order_by = 11;

Returns:: This builder for chaining.

setOrderByBytes

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

 The order in which products are returned. Products can be ordered by
 a field in an [Product][google.cloud.retail.v2.Product] object. Leave it
 unset if ordered by relevance. OrderBy expression is case-sensitive. See
 more details at this [user
 guide](https://cloud.google.com/retail/docs/filter-and-order#order).

 If this field is unrecognizable, an INVALID_ARGUMENT is returned.

string order_by = 11;

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