SearchRequest (proto-google-cloud-retail-v2 2.35.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.retail.v2.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.retail.v2.SearchService.Search] method.
 
```
Protobuf type google.cloud.retail.v2.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 items.
`static interface`	`SearchRequest.BoostSpecOrBuilder`
`static class`	`SearchRequest.Builder` Request message for [SearchService.Search][google.cloud.retail.v2.SearchService.Search] method.
`static class`	`SearchRequest.DynamicFacetSpec` The specifications of dynamically generated facets.
`static interface`	`SearchRequest.DynamicFacetSpecOrBuilder`
`static class`	`SearchRequest.FacetSpec` A facet specification to perform faceted search.
`static interface`	`SearchRequest.FacetSpecOrBuilder`
`static class`	`SearchRequest.PersonalizationSpec` The specification for personalization.
`static interface`	`SearchRequest.PersonalizationSpecOrBuilder`
`static class`	`SearchRequest.QueryExpansionSpec` Specification to determine under which conditions query expansion should occur.
`static interface`	`SearchRequest.QueryExpansionSpecOrBuilder`
`static class`	`SearchRequest.SearchMode` The search mode of each search request.
`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`	`CANONICAL_FILTER_FIELD_NUMBER`
`static int`	`DYNAMIC_FACET_SPEC_FIELD_NUMBER`
`static int`	`ENTITY_FIELD_NUMBER`
`static int`	`FACET_SPECS_FIELD_NUMBER`
`static int`	`FILTER_FIELD_NUMBER`
`static int`	`LABELS_FIELD_NUMBER`
`static int`	`OFFSET_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`	`PERSONALIZATION_SPEC_FIELD_NUMBER`
`static int`	`PLACEMENT_FIELD_NUMBER`
`static int`	`QUERY_EXPANSION_SPEC_FIELD_NUMBER`
`static int`	`QUERY_FIELD_NUMBER`
`static int`	`SEARCH_MODE_FIELD_NUMBER`
`static int`	`SPELL_CORRECTION_SPEC_FIELD_NUMBER`
`static int`	`USER_INFO_FIELD_NUMBER`
`static int`	`VARIANT_ROLLUP_KEYS_FIELD_NUMBER`
`static int`	`VISITOR_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`	`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.
`boolean`	`equals(Object obj)`
`SearchRequest.BoostSpec`	`getBoostSpec()` 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.
`static SearchRequest`	`getDefaultInstance()`
`SearchRequest`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`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.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.
`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.
`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.
`com.google.protobuf.Parser<SearchRequest>`	`getParserForType()`
`SearchRequest.PersonalizationSpec`	`getPersonalizationSpec()` 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.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.
`int`	`getSerializedSize()`
`SearchRequest.SpellCorrectionSpec`	`getSpellCorrectionSpec()` 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.
`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
`int`	`hashCode()`
`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)`
`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
- PLACEMENT_FIELD_NUMBER
```
public static final int PLACEMENT_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
- VISITOR_ID_FIELD_NUMBER
```
public static final int VISITOR_ID_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- USER_INFO_FIELD_NUMBER
```
public static final int USER_INFO_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
- 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
- FACET_SPECS_FIELD_NUMBER
```
public static final int FACET_SPECS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DYNAMIC_FACET_SPEC_FIELD_NUMBER
```
public static final int DYNAMIC_FACET_SPEC_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- BOOST_SPEC_FIELD_NUMBER
```
public static final int BOOST_SPEC_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
- VARIANT_ROLLUP_KEYS_FIELD_NUMBER
```
public static final int VARIANT_ROLLUP_KEYS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PAGE_CATEGORIES_FIELD_NUMBER
```
public static final int PAGE_CATEGORIES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SEARCH_MODE_FIELD_NUMBER
```
public static final int SEARCH_MODE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PERSONALIZATION_SPEC_FIELD_NUMBER
```
public static final int PERSONALIZATION_SPEC_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LABELS_FIELD_NUMBER
```
public static final int LABELS_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
- ENTITY_FIELD_NUMBER
```
public static final int ENTITY_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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.