Interface SearchRequestOrBuilder (2.26.0)

public interface SearchRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract 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.
Each label must be a key-value pair.
Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
The key portion of a label must be unique. However, you can use the same key with multiple resources.
Keys must start with a lowercase letter or international character.

See Google Cloud Document for more details.

map<string, string> labels = 34;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

getBoostSpec()

public abstract SearchRequest.BoostSpec getBoostSpec()

Boost specification to boost certain products. See more details at this user guide.

Notice that if both ServingConfig.boost_control_ids and SearchRequest.boost_spec are set, the boost conditions from both places are evaluated. If a search request matches multiple boost conditions, the final boost score is equal to the sum of the boost scores from all matched boost conditions.

.google.cloud.retail.v2alpha.SearchRequest.BoostSpec boost_spec = 13;

Returns
Type	Description
`SearchRequest.BoostSpec`	The boostSpec.

getBoostSpecOrBuilder()

public abstract SearchRequest.BoostSpecOrBuilder getBoostSpecOrBuilder()

Boost specification to boost certain products. See more details at this user guide.

.google.cloud.retail.v2alpha.SearchRequest.BoostSpec boost_spec = 13;

Returns
Type	Description
`SearchRequest.BoostSpecOrBuilder`

getBranch()

public abstract 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
Type	Description
`String`	The branch.

getBranchBytes()

public abstract 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
Type	Description
`ByteString`	The bytes for branch.

getCanonicalFilter()

public abstract 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 will be returned as a supplement of the original query. This field is strongly recommended to achieve high search quality.

See SearchRequest.filter for more details about filter syntax.

string canonical_filter = 28;

Returns
Type	Description
`String`	The canonicalFilter.

getCanonicalFilterBytes()

public abstract ByteString getCanonicalFilterBytes()

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

See SearchRequest.filter for more details about filter syntax.

string canonical_filter = 28;

Returns
Type	Description
`ByteString`	The bytes for canonicalFilter.

getDynamicFacetSpec() (deprecated)

public abstract SearchRequest.DynamicFacetSpec getDynamicFacetSpec()

Deprecated. google.cloud.retail.v2alpha.SearchRequest.dynamic_facet_spec is deprecated. See google/cloud/retail/v2alpha/search_service.proto;l=622

Deprecated. Refer to https://cloud.google.com/retail/docs/configs#dynamic to enable dynamic facets. Do not set this field.

The specification for dynamically generated facets. Notice that only textual facets can be dynamically generated.

.google.cloud.retail.v2alpha.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 21 [deprecated = true];

Returns
Type	Description
`SearchRequest.DynamicFacetSpec`	The dynamicFacetSpec.

getDynamicFacetSpecOrBuilder()

public abstract SearchRequest.DynamicFacetSpecOrBuilder getDynamicFacetSpecOrBuilder()

Deprecated. Refer to https://cloud.google.com/retail/docs/configs#dynamic to enable dynamic facets. Do not set this field.

The specification for dynamically generated facets. Notice that only textual facets can be dynamically generated.

.google.cloud.retail.v2alpha.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 21 [deprecated = true];

Returns
Type	Description
`SearchRequest.DynamicFacetSpecOrBuilder`

getEntity()

public abstract 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. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity.

string entity = 38;

Returns
Type	Description
`String`	The entity.

getEntityBytes()

public abstract ByteString getEntityBytes()

string entity = 38;

Returns
Type	Description
`ByteString`	The bytes for entity.

getFacetSpecs(int index)

public abstract SearchRequest.FacetSpec getFacetSpecs(int index)

Facet specifications for faceted search. If empty, no facets are returned.

A maximum of 200 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

repeated .google.cloud.retail.v2alpha.SearchRequest.FacetSpec facet_specs = 12;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`SearchRequest.FacetSpec`

getFacetSpecsCount()

public abstract int getFacetSpecsCount()

Facet specifications for faceted search. If empty, no facets are returned.

A maximum of 200 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

repeated .google.cloud.retail.v2alpha.SearchRequest.FacetSpec facet_specs = 12;

Returns
Type	Description
`int`

getFacetSpecsList()

public abstract List<SearchRequest.FacetSpec> getFacetSpecsList()

Facet specifications for faceted search. If empty, no facets are returned.

A maximum of 200 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

repeated .google.cloud.retail.v2alpha.SearchRequest.FacetSpec facet_specs = 12;

Returns
Type	Description
`List<FacetSpec>`

getFacetSpecsOrBuilder(int index)

public abstract SearchRequest.FacetSpecOrBuilder getFacetSpecsOrBuilder(int index)

Facet specifications for faceted search. If empty, no facets are returned.

A maximum of 200 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

repeated .google.cloud.retail.v2alpha.SearchRequest.FacetSpec facet_specs = 12;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`SearchRequest.FacetSpecOrBuilder`

getFacetSpecsOrBuilderList()

public abstract List<? extends SearchRequest.FacetSpecOrBuilder> getFacetSpecsOrBuilderList()

Facet specifications for faceted search. If empty, no facets are returned.

A maximum of 200 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

repeated .google.cloud.retail.v2alpha.SearchRequest.FacetSpec facet_specs = 12;

Returns
Type	Description
`List<? extends com.google.cloud.retail.v2alpha.SearchRequest.FacetSpecOrBuilder>`

getFilter()

public abstract 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.

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

string filter = 10;

Returns
Type	Description
`String`	The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

string filter = 10;

Returns
Type	Description
`ByteString`	The bytes for filter.

getLabels()

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
`Map<String,String>`

getLabelsCount()

public abstract 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.
Each label must be a key-value pair.
Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
The key portion of a label must be unique. However, you can use the same key with multiple resources.
Keys must start with a lowercase letter or international character.

See Google Cloud Document for more details.

map<string, string> labels = 34;

Returns
Type	Description
`int`

getLabelsMap()

public abstract 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.
Each label must be a key-value pair.
Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
The key portion of a label must be unique. However, you can use the same key with multiple resources.
Keys must start with a lowercase letter or international character.

See Google Cloud Document for more details.

map<string, string> labels = 34;

Returns
Type	Description
`Map<String,String>`

getLabelsOrDefault(String key, String defaultValue)

public abstract 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.
Each label must be a key-value pair.
Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
The key portion of a label must be unique. However, you can use the same key with multiple resources.
Keys must start with a lowercase letter or international character.

See Google Cloud Document for more details.

map<string, string> labels = 34;

Parameters
Name	Description
`key`	`String`
`defaultValue`	`String`

Returns
Type	Description
`String`

getLabelsOrThrow(String key)

public abstract 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.
Each label must be a key-value pair.
Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
The key portion of a label must be unique. However, you can use the same key with multiple resources.
Keys must start with a lowercase letter or international character.

See Google Cloud Document for more details.

map<string, string> labels = 34;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`String`

getOffset()

public abstract int getOffset()

A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Products deemed by the API as relevant) in search results. This field is only considered if page_token is unset.

If this field is negative, an INVALID_ARGUMENT is returned.

int32 offset = 9;

Returns
Type	Description
`int`	The offset.

getOrderBy()

public abstract String getOrderBy()

The order in which products are returned. Products can be ordered by a field in an Product object. Leave it unset if ordered by relevance. OrderBy expression is case-sensitive. See more details at this user guide.

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

string order_by = 11;

Returns
Type	Description
`String`	The orderBy.

getOrderByBytes()

public abstract ByteString getOrderByBytes()

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

string order_by = 11;

Returns
Type	Description
`ByteString`	The bytes for orderBy.

getPageCategories(int index)

public abstract String getPageCategories(int index)

The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories;

To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s).

Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].

repeated string page_categories = 23;

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The pageCategories at the given index.

getPageCategoriesBytes(int index)

public abstract ByteString getPageCategoriesBytes(int index)

The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories;

To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s).

Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].

repeated string page_categories = 23;

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the pageCategories at the given index.

getPageCategoriesCount()

public abstract int getPageCategoriesCount()

The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories;

To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s).

Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].

repeated string page_categories = 23;

Returns
Type	Description
`int`	The count of pageCategories.

getPageCategoriesList()

public abstract List<String> getPageCategoriesList()

The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories;

To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s).

Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].

repeated string page_categories = 23;

Returns
Type	Description
`List<String>`	A list containing the pageCategories.

getPageSize()

public abstract int getPageSize()

Maximum number of Products 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
Type	Description
`int`	The pageSize.

getPageToken()

public abstract String getPageToken()

A page token SearchResponse.next_page_token, received from a previous SearchService.Search call. Provide this to retrieve the subsequent page.

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

string page_token = 8;

Returns
Type	Description
`String`	The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

A page token SearchResponse.next_page_token, received from a previous SearchService.Search call. Provide this to retrieve the subsequent page.

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

string page_token = 8;

Returns
Type	Description
`ByteString`	The bytes for pageToken.

getPersonalizationSpec()

public abstract SearchRequest.PersonalizationSpec getPersonalizationSpec()

The specification for personalization.

Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set. SearchRequest.personalization_spec will override ServingConfig.personalization_spec.

.google.cloud.retail.v2alpha.SearchRequest.PersonalizationSpec personalization_spec = 32;

Returns
Type	Description
`SearchRequest.PersonalizationSpec`	The personalizationSpec.

getPersonalizationSpecOrBuilder()

public abstract SearchRequest.PersonalizationSpecOrBuilder getPersonalizationSpecOrBuilder()

The specification for personalization.

Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set. SearchRequest.personalization_spec will override ServingConfig.personalization_spec.

.google.cloud.retail.v2alpha.SearchRequest.PersonalizationSpec personalization_spec = 32;

Returns
Type	Description
`SearchRequest.PersonalizationSpecOrBuilder`

getPlacement()

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

Returns
Type	Description
`String`	The placement.

getPlacementBytes()

public abstract ByteString getPlacementBytes()

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

Returns
Type	Description
`ByteString`	The bytes for placement.

getQuery()

public abstract 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 and page_categories.

string query = 3;

Returns
Type	Description
`String`	The query.

getQueryBytes()

public abstract 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 and page_categories.

string query = 3;

Returns
Type	Description
`ByteString`	The bytes for query.

getQueryExpansionSpec()

public abstract SearchRequest.QueryExpansionSpec getQueryExpansionSpec()

The query expansion specification that specifies the conditions under which query expansion will occur. See more details at this user guide.

.google.cloud.retail.v2alpha.SearchRequest.QueryExpansionSpec query_expansion_spec = 14;

Returns
Type	Description
`SearchRequest.QueryExpansionSpec`	The queryExpansionSpec.

getQueryExpansionSpecOrBuilder()

public abstract SearchRequest.QueryExpansionSpecOrBuilder getQueryExpansionSpecOrBuilder()

The query expansion specification that specifies the conditions under which query expansion will occur. See more details at this user guide.

.google.cloud.retail.v2alpha.SearchRequest.QueryExpansionSpec query_expansion_spec = 14;

Returns
Type	Description
`SearchRequest.QueryExpansionSpecOrBuilder`

getRelevanceThreshold()

public abstract SearchRequest.RelevanceThreshold getRelevanceThreshold()

The relevance threshold of the search results.

Defaults to RelevanceThreshold.HIGH, which means only the most relevant results are shown, and the least number of results are returned. See more details at this user guide.

.google.cloud.retail.v2alpha.SearchRequest.RelevanceThreshold relevance_threshold = 15;

Returns
Type	Description
`SearchRequest.RelevanceThreshold`	The relevanceThreshold.

getRelevanceThresholdValue()

public abstract int getRelevanceThresholdValue()

The relevance threshold of the search results.

Defaults to RelevanceThreshold.HIGH, which means only the most relevant results are shown, and the least number of results are returned. See more details at this user guide.

.google.cloud.retail.v2alpha.SearchRequest.RelevanceThreshold relevance_threshold = 15;

Returns
Type	Description
`int`	The enum numeric value on the wire for relevanceThreshold.

getSearchMode()

public abstract SearchRequest.SearchMode getSearchMode()

The search mode of the search request. If not specified, a single search request triggers both product search and faceted search.

.google.cloud.retail.v2alpha.SearchRequest.SearchMode search_mode = 31;

Returns
Type	Description
`SearchRequest.SearchMode`	The searchMode.

getSearchModeValue()

public abstract int getSearchModeValue()

The search mode of the search request. If not specified, a single search request triggers both product search and faceted search.

.google.cloud.retail.v2alpha.SearchRequest.SearchMode search_mode = 31;

Returns
Type	Description
`int`	The enum numeric value on the wire for searchMode.

getSpellCorrectionSpec()

public abstract SearchRequest.SpellCorrectionSpec getSpellCorrectionSpec()

The spell correction specification that specifies the mode under which spell correction will take effect.

optional .google.cloud.retail.v2alpha.SearchRequest.SpellCorrectionSpec spell_correction_spec = 35;

Returns
Type	Description
`SearchRequest.SpellCorrectionSpec`	The spellCorrectionSpec.

getSpellCorrectionSpecOrBuilder()

public abstract SearchRequest.SpellCorrectionSpecOrBuilder getSpellCorrectionSpecOrBuilder()

The spell correction specification that specifies the mode under which spell correction will take effect.

optional .google.cloud.retail.v2alpha.SearchRequest.SpellCorrectionSpec spell_correction_spec = 35;

Returns
Type	Description
`SearchRequest.SpellCorrectionSpecOrBuilder`

getUserInfo()

public abstract UserInfo getUserInfo()

User information.

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

Returns
Type	Description
`UserInfo`	The userInfo.

getUserInfoOrBuilder()

public abstract UserInfoOrBuilder getUserInfoOrBuilder()

User information.

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

Returns
Type	Description
`UserInfoOrBuilder`

getVariantRollupKeys(int index)

public abstract String getVariantRollupKeys(int index)

The keys to fetch and rollup the matching variant Products attributes, FulfillmentInfo or LocalInventorys attributes. The attributes from all the matching variant Products or LocalInventorys are merged and de-duplicated. Notice that rollup attributes will lead to extra query latency. Maximum number of keys is 30.

For FulfillmentInfo, a fulfillment type and a fulfillment ID must be provided in the format of "fulfillmentType.fulfillmentId". E.g., in "pickupInStore.store123", "pickupInStore" is fulfillment type and "store123" is the store ID.

Supported keys are:

colorFamilies
price
originalPrice
discount
variantId
inventory(place_id,price)
inventory(place_id,original_price)
inventory(place_id,attributes.key), where key is any key in the Product.local_inventories.attributes map.
attributes.key, where key is any key in the Product.attributes map.
pickupInStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "pickup-in-store".
shipToStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "ship-to-store".
sameDayDelivery.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "same-day-delivery".
nextDayDelivery.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "next-day-delivery".
customFulfillment1.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-1".
customFulfillment2.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-2".
customFulfillment3.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-3".
customFulfillment4.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-4".
customFulfillment5.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-5".

If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned.

repeated string variant_rollup_keys = 17;

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The variantRollupKeys at the given index.

getVariantRollupKeysBytes(int index)

public abstract ByteString getVariantRollupKeysBytes(int index)

Supported keys are:

colorFamilies
price
originalPrice
discount
variantId
inventory(place_id,price)
inventory(place_id,original_price)
inventory(place_id,attributes.key), where key is any key in the Product.local_inventories.attributes map.
attributes.key, where key is any key in the Product.attributes map.
pickupInStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "pickup-in-store".
shipToStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "ship-to-store".
sameDayDelivery.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "same-day-delivery".
nextDayDelivery.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "next-day-delivery".
customFulfillment1.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-1".
customFulfillment2.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-2".
customFulfillment3.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-3".
customFulfillment4.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-4".
customFulfillment5.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-5".

If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned.

repeated string variant_rollup_keys = 17;

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the variantRollupKeys at the given index.

getVariantRollupKeysCount()

public abstract int getVariantRollupKeysCount()

Supported keys are:

colorFamilies
price
originalPrice
discount
variantId
inventory(place_id,price)
inventory(place_id,original_price)
inventory(place_id,attributes.key), where key is any key in the Product.local_inventories.attributes map.
attributes.key, where key is any key in the Product.attributes map.
pickupInStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "pickup-in-store".
shipToStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "ship-to-store".
sameDayDelivery.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "same-day-delivery".
nextDayDelivery.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "next-day-delivery".
customFulfillment1.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-1".
customFulfillment2.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-2".
customFulfillment3.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-3".
customFulfillment4.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-4".
customFulfillment5.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-5".

If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned.

repeated string variant_rollup_keys = 17;

Returns
Type	Description
`int`	The count of variantRollupKeys.

getVariantRollupKeysList()

public abstract List<String> getVariantRollupKeysList()

Supported keys are:

colorFamilies
price
originalPrice
discount
variantId
inventory(place_id,price)
inventory(place_id,original_price)
inventory(place_id,attributes.key), where key is any key in the Product.local_inventories.attributes map.
attributes.key, where key is any key in the Product.attributes map.
pickupInStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "pickup-in-store".
shipToStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "ship-to-store".
sameDayDelivery.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "same-day-delivery".
nextDayDelivery.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "next-day-delivery".
customFulfillment1.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-1".
customFulfillment2.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-2".
customFulfillment3.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-3".
customFulfillment4.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-4".
customFulfillment5.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-5".

If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned.

repeated string variant_rollup_keys = 17;

Returns
Type	Description
`List<String>`	A list containing the variantRollupKeys.

getVisitorId()

public abstract 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.

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
Type	Description
`String`	The visitorId.

getVisitorIdBytes()

public abstract ByteString getVisitorIdBytes()

This should be the same identifier as 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
Type	Description
`ByteString`	The bytes for visitorId.

hasBoostSpec()

public abstract boolean hasBoostSpec()

Boost specification to boost certain products. See more details at this user guide.

.google.cloud.retail.v2alpha.SearchRequest.BoostSpec boost_spec = 13;

Returns
Type	Description
`boolean`	Whether the boostSpec field is set.

hasDynamicFacetSpec() (deprecated)

public abstract boolean hasDynamicFacetSpec()

Deprecated. google.cloud.retail.v2alpha.SearchRequest.dynamic_facet_spec is deprecated. See google/cloud/retail/v2alpha/search_service.proto;l=622

Deprecated. Refer to https://cloud.google.com/retail/docs/configs#dynamic to enable dynamic facets. Do not set this field.

The specification for dynamically generated facets. Notice that only textual facets can be dynamically generated.

.google.cloud.retail.v2alpha.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 21 [deprecated = true];

Returns
Type	Description
`boolean`	Whether the dynamicFacetSpec field is set.

hasPersonalizationSpec()

public abstract boolean hasPersonalizationSpec()

The specification for personalization.

Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set. SearchRequest.personalization_spec will override ServingConfig.personalization_spec.

.google.cloud.retail.v2alpha.SearchRequest.PersonalizationSpec personalization_spec = 32;

Returns
Type	Description
`boolean`	Whether the personalizationSpec field is set.

hasQueryExpansionSpec()

public abstract boolean hasQueryExpansionSpec()

The query expansion specification that specifies the conditions under which query expansion will occur. See more details at this user guide.

.google.cloud.retail.v2alpha.SearchRequest.QueryExpansionSpec query_expansion_spec = 14;

Returns
Type	Description
`boolean`	Whether the queryExpansionSpec field is set.

hasSpellCorrectionSpec()

public abstract boolean hasSpellCorrectionSpec()

The spell correction specification that specifies the mode under which spell correction will take effect.

optional .google.cloud.retail.v2alpha.SearchRequest.SpellCorrectionSpec spell_correction_spec = 35;

Returns
Type	Description
`boolean`	Whether the spellCorrectionSpec field is set.

hasUserInfo()

public abstract boolean hasUserInfo()

User information.

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

Returns
Type	Description
`boolean`	Whether the userInfo field is set.