SearchRequestOrBuilder (proto-google-cloud-retail-v2 2.62.0 API)

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

SearchRequest, SearchRequest.Builder
```
public interface SearchRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract 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
`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.
`SearchRequest.ConversationalSearchSpec`	`getConversationalSearchSpec()` Optional.
`SearchRequest.ConversationalSearchSpecOrBuilder`	`getConversationalSearchSpecOrBuilder()` Optional.
`SearchRequest.DynamicFacetSpec`	`getDynamicFacetSpec()` Deprecated. google.cloud.retail.v2.SearchRequest.dynamic_facet_spec is deprecated. See google/cloud/retail/v2/search_service.proto;l=696
`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.
`List<String>`	`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.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 occurs.
`SearchRequest.QueryExpansionSpecOrBuilder`	`getQueryExpansionSpecOrBuilder()` The query expansion specification that specifies the conditions under which query expansion occurs.
`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.SpellCorrectionSpecOrBuilder`	`getSpellCorrectionSpecOrBuilder()` The spell correction specification that specifies the mode under which spell correction will take effect.
`SearchRequest.TileNavigationSpec`	`getTileNavigationSpec()` Optional.
`SearchRequest.TileNavigationSpecOrBuilder`	`getTileNavigationSpecOrBuilder()` Optional.
`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.
`List<String>`	`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`	`hasConversationalSearchSpec()` Optional.
`boolean`	`hasDynamicFacetSpec()` Deprecated. google.cloud.retail.v2.SearchRequest.dynamic_facet_spec is deprecated. See google/cloud/retail/v2/search_service.proto;l=696
`boolean`	`hasPersonalizationSpec()` The specification for personalization.
`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 will take effect.
`boolean`	`hasTileNavigationSpec()` Optional.
`boolean`	`hasUserInfo()` User information.

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

Method Detail

getPlacement

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 are used to make the search.

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

Returns:: The placement.

getPlacementBytes

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 are used to make the search.

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

Returns:: The bytes for placement.

getBranch

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) = { ... }

Returns:: The branch.

getBranchBytes

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) = { ... }

Returns:: The bytes for branch.

getQuery

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;

Returns:: The query.

getQueryBytes

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;

Returns:: The bytes for query.

getVisitorId

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];

Returns:: The visitorId.

getVisitorIdBytes

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];

Returns:: The bytes for visitorId.

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

Whether the userInfo field is set.

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

The userInfo.

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

getPageSize

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;

Returns:: The pageSize.

getPageToken

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;

Returns:: The pageToken.

getPageTokenBytes

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;

Returns:: The bytes for pageToken.

getOffset

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;

Returns:: The offset.

getFilter

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. For more information, see
 [Filter](https://cloud.google.com/retail/docs/filter-and-order#filter).

 If this field is unrecognizable, an INVALID_ARGUMENT is returned.

string filter = 10;

Returns:: The filter.

getFilterBytes

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. For more information, see
 [Filter](https://cloud.google.com/retail/docs/filter-and-order#filter).

 If this field is unrecognizable, an INVALID_ARGUMENT is returned.

string filter = 10;

Returns:: The bytes for filter.

getCanonicalFilter

String getCanonicalFilter()

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

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

 For more information about filter syntax, see
 [SearchRequest.filter][google.cloud.retail.v2.SearchRequest.filter].

string canonical_filter = 28;

Returns:: The canonicalFilter.

getCanonicalFilterBytes

com.google.protobuf.ByteString getCanonicalFilterBytes()

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

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

 For more information about filter syntax, see
 [SearchRequest.filter][google.cloud.retail.v2.SearchRequest.filter].

string canonical_filter = 28;

Returns:: The bytes for canonicalFilter.

getOrderBy

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. For
 more information, see
 [Order](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:: The orderBy.

getOrderByBytes

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. For
 more information, see
 [Order](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:: The bytes for orderBy.