Package com.google.cloud.retail.v2alpha

Interface SearchRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
SearchRequest, SearchRequest.Builder
@Generated public interface SearchRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • 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.v2alpha.SearchRequest.filter] and
 [page_categories][google.cloud.retail.v2alpha.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.v2alpha.SearchRequest.filter] and
 [page_categories][google.cloud.retail.v2alpha.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.v2alpha.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.v2alpha.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.v2alpha.UserInfo user_info = 5;
      Returns:
      Whether the userInfo field is set.

    • getUserInfo

      UserInfo getUserInfo()
       User information.
      .google.cloud.retail.v2alpha.UserInfo user_info = 5;
      Returns:
      The userInfo.

    • getUserInfoOrBuilder

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

    • getPageSize

      int getPageSize()
       Maximum number of [Product][google.cloud.retail.v2alpha.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.v2alpha.SearchResponse.next_page_token],
 received from a previous
 [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [SearchService.Search][google.cloud.retail.v2alpha.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.v2alpha.SearchResponse.next_page_token],
 received from a previous
 [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search]
 call. Provide this to retrieve the subsequent page.

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

    • getFacetSpecsList

      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;

    • getFacetSpecs

      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;

    • getFacetSpecsCount

      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;

    • getFacetSpecsOrBuilderList

      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;

    • getFacetSpecsOrBuilder

      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;

    • hasDynamicFacetSpec

      @Deprecated boolean hasDynamicFacetSpec()
      Deprecated.
      google.cloud.retail.v2alpha.SearchRequest.dynamic_facet_spec is deprecated. See google/cloud/retail/v2alpha/search_service.proto;l=725
       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:
      Whether the dynamicFacetSpec field is set.

    • getDynamicFacetSpec

      @Deprecated SearchRequest.DynamicFacetSpec getDynamicFacetSpec()
      Deprecated.
      google.cloud.retail.v2alpha.SearchRequest.dynamic_facet_spec is deprecated. See google/cloud/retail/v2alpha/search_service.proto;l=725
       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:
      The dynamicFacetSpec.

    • getDynamicFacetSpecOrBuilder

      @Deprecated SearchRequest.DynamicFacetSpecOrBuilder getDynamicFacetSpecOrBuilder()
      Deprecated.
       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];

    • hasBoostSpec

      boolean hasBoostSpec()
       Boost specification to boost certain products. For more information, see
 [Boost results](https://cloud.google.com/retail/docs/boosting).

 Notice that if both
 [ServingConfig.boost_control_ids][google.cloud.retail.v2alpha.ServingConfig.boost_control_ids]
 and
 [SearchRequest.boost_spec][google.cloud.retail.v2alpha.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:
      Whether the boostSpec field is set.

    • getBoostSpec

      SearchRequest.BoostSpec getBoostSpec()
       Boost specification to boost certain products. For more information, see
 [Boost results](https://cloud.google.com/retail/docs/boosting).

 Notice that if both
 [ServingConfig.boost_control_ids][google.cloud.retail.v2alpha.ServingConfig.boost_control_ids]
 and
 [SearchRequest.boost_spec][google.cloud.retail.v2alpha.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:
      The boostSpec.

    • getBoostSpecOrBuilder

      SearchRequest.BoostSpecOrBuilder getBoostSpecOrBuilder()
       Boost specification to boost certain products. For more information, see
 [Boost results](https://cloud.google.com/retail/docs/boosting).

 Notice that if both
 [ServingConfig.boost_control_ids][google.cloud.retail.v2alpha.ServingConfig.boost_control_ids]
 and
 [SearchRequest.boost_spec][google.cloud.retail.v2alpha.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;

    • hasQueryExpansionSpec

      boolean hasQueryExpansionSpec()
       The query expansion specification that specifies the conditions under which
 query expansion occurs. For more information, see [Query
 expansion](https://cloud.google.com/retail/docs/result-size#query_expansion).
      .google.cloud.retail.v2alpha.SearchRequest.QueryExpansionSpec query_expansion_spec = 14;
      Returns:
      Whether the queryExpansionSpec field is set.

    • getQueryExpansionSpec

      SearchRequest.QueryExpansionSpec getQueryExpansionSpec()
       The query expansion specification that specifies the conditions under which
 query expansion occurs. For more information, see [Query
 expansion](https://cloud.google.com/retail/docs/result-size#query_expansion).
      .google.cloud.retail.v2alpha.SearchRequest.QueryExpansionSpec query_expansion_spec = 14;
      Returns:
      The queryExpansionSpec.

    • getQueryExpansionSpecOrBuilder

      SearchRequest.QueryExpansionSpecOrBuilder getQueryExpansionSpecOrBuilder()
       The query expansion specification that specifies the conditions under which
 query expansion occurs. For more information, see [Query
 expansion](https://cloud.google.com/retail/docs/result-size#query_expansion).
      .google.cloud.retail.v2alpha.SearchRequest.QueryExpansionSpec query_expansion_spec = 14;

    • getRelevanceThresholdValue

      int getRelevanceThresholdValue()
       The relevance threshold of the search results.

 Defaults to
 [RelevanceThreshold.HIGH][google.cloud.retail.v2alpha.SearchRequest.RelevanceThreshold.HIGH],
 which means only the most relevant results are shown, and the least number
 of results are returned. For more information, see [Adjust result
 size](https://cloud.google.com/retail/docs/result-size#relevance_thresholding).
      .google.cloud.retail.v2alpha.SearchRequest.RelevanceThreshold relevance_threshold = 15;
      Returns:
      The enum numeric value on the wire for relevanceThreshold.

    • getRelevanceThreshold

      SearchRequest.RelevanceThreshold getRelevanceThreshold()
       The relevance threshold of the search results.

 Defaults to
 [RelevanceThreshold.HIGH][google.cloud.retail.v2alpha.SearchRequest.RelevanceThreshold.HIGH],
 which means only the most relevant results are shown, and the least number
 of results are returned. For more information, see [Adjust result
 size](https://cloud.google.com/retail/docs/result-size#relevance_thresholding).
      .google.cloud.retail.v2alpha.SearchRequest.RelevanceThreshold relevance_threshold = 15;
      Returns:
      The relevanceThreshold.

    • getVariantRollupKeysList

      List<String> getVariantRollupKeysList()
       The keys to fetch and rollup the matching
 [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2alpha.Product]s attributes,
 [FulfillmentInfo][google.cloud.retail.v2alpha.FulfillmentInfo] or
 [LocalInventory][google.cloud.retail.v2alpha.LocalInventory]s attributes.
 The attributes from all the matching
 [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2alpha.Product]s or
 [LocalInventory][google.cloud.retail.v2alpha.LocalInventory]s are merged
 and de-duplicated. Notice that rollup attributes will lead to extra query
 latency. Maximum number of keys is 30.

 For [FulfillmentInfo][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.LocalInventory.attributes]
 map.
 * attributes.key, where key is any key in the
 [Product.attributes][google.cloud.retail.v2alpha.Product.attributes] map.
 * pickupInStore.id, where id is any
 [FulfillmentInfo.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids]
 for
 [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type]
 "pickup-in-store".
 * shipToStore.id, where id is any
 [FulfillmentInfo.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids]
 for
 [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type]
 "ship-to-store".
 * sameDayDelivery.id, where id is any
 [FulfillmentInfo.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids]
 for
 [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type]
 "same-day-delivery".
 * nextDayDelivery.id, where id is any
 [FulfillmentInfo.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids]
 for
 [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type]
 "next-day-delivery".
 * customFulfillment1.id, where id is any
 [FulfillmentInfo.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids]
 for
 [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type]
 "custom-type-1".
 * customFulfillment2.id, where id is any
 [FulfillmentInfo.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids]
 for
 [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type]
 "custom-type-2".
 * customFulfillment3.id, where id is any
 [FulfillmentInfo.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids]
 for
 [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type]
 "custom-type-3".
 * customFulfillment4.id, where id is any
 [FulfillmentInfo.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids]
 for
 [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type]
 "custom-type-4".
 * customFulfillment5.id, where id is any
 [FulfillmentInfo.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids]
 for
 [FulfillmentInfo.type][google.cloud.retail.v2alpha.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:
      A list containing the variantRollupKeys.

    • getVariantRollupKeysCount

      int getVariantRollupKeysCount()
       The keys to fetch and rollup the matching
 [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2alpha.Product]s attributes,
 [FulfillmentInfo][google.cloud.retail.v2alpha.FulfillmentInfo] or
 [LocalInventory][google.cloud.retail.v2alpha.LocalInventory]s attributes.
 The attributes from all the matching
 [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2alpha.Product]s or
 [LocalInventory][google.cloud.retail.v2alpha.LocalInventory]s are merged
 and de-duplicated. Notice that rollup attributes will lead to extra query
 latency. Maximum number of keys is 30.

 For [FulfillmentInfo][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.LocalInventory.attributes]
 map.
 * attributes.key, where key is any key in the
 [Product.attributes][google.cloud.retail.v2alpha.Product.attributes] map.
 * pickupInStore.id, where id is any
 [FulfillmentInfo.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids]
 for
 [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type]
 "pickup-in-store".
 * shipToStore.id, where id is any
 [FulfillmentInfo.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids]
 for
 [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type]
 "ship-to-store".
 * sameDayDelivery.id, where id is any
 [FulfillmentInfo.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids]
 for
 [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type]
 "same-day-delivery".
 * nextDayDelivery.id, where id is any
 [FulfillmentInfo.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids]
 for
 [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type]
 "next-day-delivery".
 * customFulfillment1.id, where id is any
 [FulfillmentInfo.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids]
 for
 [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type]
 "custom-type-1".
 * customFulfillment2.id, where id is any
 [FulfillmentInfo.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids]
 for
 [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type]
 "custom-type-2".
 * customFulfillment3.id, where id is any
 [FulfillmentInfo.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids]
 for
 [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type]
 "custom-type-3".
 * customFulfillment4.id, where id is any
 [FulfillmentInfo.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids]
 for
 [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type]
 "custom-type-4".
 * customFulfillment5.id, where id is any
 [FulfillmentInfo.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids]
 for
 [FulfillmentInfo.type][google.cloud.retail.v2alpha.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:
      The count of variantRollupKeys.

    • getVariantRollupKeys

      String getVariantRollupKeys(int index)
       The keys to fetch and rollup the matching
 [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2alpha.Product]s attributes,
 [FulfillmentInfo][google.cloud.retail.v2alpha.FulfillmentInfo] or
 [LocalInventory][google.cloud.retail.v2alpha.LocalInventory]s attributes.
 The attributes from all the matching
 [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2alpha.Product]s or
 [LocalInventory][google.cloud.retail.v2alpha.LocalInventory]s are merged
 and de-duplicated. Notice that rollup attributes will lead to extra query
 latency. Maximum number of keys is 30.

 For [FulfillmentInfo][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.LocalInventory.attributes]
 map.
 * attributes.key, where key is any key in the
 [Product.attributes][google.cloud.retail.v2alpha.Product.attributes] map.
 * pickupInStore.id, where id is any
 [FulfillmentInfo.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids]
 for
 [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type]
 "pickup-in-store".
 * shipToStore.id, where id is any
 [FulfillmentInfo.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids]
 for
 [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type]
 "ship-to-store".
 * sameDayDelivery.id, where id is any
 [FulfillmentInfo.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids]
 for
 [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type]
 "same-day-delivery".
 * nextDayDelivery.id, where id is any
 [FulfillmentInfo.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids]
 for
 [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type]
 "next-day-delivery".
 * customFulfillment1.id, where id is any
 [FulfillmentInfo.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids]
 for
 [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type]
 "custom-type-1".
 * customFulfillment2.id, where id is any
 [FulfillmentInfo.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids]
 for
 [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type]
 "custom-type-2".
 * customFulfillment3.id, where id is any
 [FulfillmentInfo.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids]
 for
 [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type]
 "custom-type-3".
 * customFulfillment4.id, where id is any
 [FulfillmentInfo.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids]
 for
 [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type]
 "custom-type-4".
 * customFulfillment5.id, where id is any
 [FulfillmentInfo.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids]
 for
 [FulfillmentInfo.type][google.cloud.retail.v2alpha.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;
      Parameters:
      index - The index of the element to return.
      Returns:
      The variantRollupKeys at the given index.

    • getVariantRollupKeysBytes

      com.google.protobuf.ByteString getVariantRollupKeysBytes(int index)
       The keys to fetch and rollup the matching
 [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2alpha.Product]s attributes,
 [FulfillmentInfo][google.cloud.retail.v2alpha.FulfillmentInfo] or
 [LocalInventory][google.cloud.retail.v2alpha.LocalInventory]s attributes.
 The attributes from all the matching
 [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2alpha.Product]s or
 [LocalInventory][google.cloud.retail.v2alpha.LocalInventory]s are merged
 and de-duplicated. Notice that rollup attributes will lead to extra query
 latency. Maximum number of keys is 30.

 For [FulfillmentInfo][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.LocalInventory.attributes]
 map.
 * attributes.key, where key is any key in the
 [Product.attributes][google.cloud.retail.v2alpha.Product.attributes] map.
 * pickupInStore.id, where id is any
 [FulfillmentInfo.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids]
 for
 [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type]
 "pickup-in-store".
 * shipToStore.id, where id is any
 [FulfillmentInfo.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids]
 for
 [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type]
 "ship-to-store".
 * sameDayDelivery.id, where id is any
 [FulfillmentInfo.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids]
 for
 [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type]
 "same-day-delivery".
 * nextDayDelivery.id, where id is any
 [FulfillmentInfo.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids]
 for
 [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type]
 "next-day-delivery".
 * customFulfillment1.id, where id is any
 [FulfillmentInfo.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids]
 for
 [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type]
 "custom-type-1".
 * customFulfillment2.id, where id is any
 [FulfillmentInfo.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids]
 for
 [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type]
 "custom-type-2".
 * customFulfillment3.id, where id is any
 [FulfillmentInfo.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids]
 for
 [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type]
 "custom-type-3".
 * customFulfillment4.id, where id is any
 [FulfillmentInfo.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids]
 for
 [FulfillmentInfo.type][google.cloud.retail.v2alpha.FulfillmentInfo.type]
 "custom-type-4".
 * customFulfillment5.id, where id is any
 [FulfillmentInfo.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids]
 for
 [FulfillmentInfo.type][google.cloud.retail.v2alpha.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;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the variantRollupKeys at the given index.

    • getExperimentId

      String getExperimentId()
       Optional. An ID for the experiment group this search belongs to.
      string experiment_id = 18 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The experimentId.

    • getExperimentIdBytes

      com.google.protobuf.ByteString getExperimentIdBytes()
       Optional. An ID for the experiment group this search belongs to.
      string experiment_id = 18 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for experimentId.

    • getPageCategoriesList

      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][google.cloud.retail.v2alpha.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:
      A list containing the pageCategories.

    • getPageCategoriesCount

      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][google.cloud.retail.v2alpha.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:
      The count of pageCategories.

    • getPageCategories

      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][google.cloud.retail.v2alpha.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;
      Parameters:
      index - The index of the element to return.
      Returns:
      The pageCategories at the given index.

    • getPageCategoriesBytes

      com.google.protobuf.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][google.cloud.retail.v2alpha.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;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the pageCategories at the given index.

    • getSearchModeValue

      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:
      The enum numeric value on the wire for searchMode.

    • getSearchMode

      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:
      The searchMode.

    • hasPersonalizationSpec

      boolean hasPersonalizationSpec()
       The specification for personalization.

 Notice that if both
 [ServingConfig.personalization_spec][google.cloud.retail.v2alpha.ServingConfig.personalization_spec]
 and
 [SearchRequest.personalization_spec][google.cloud.retail.v2alpha.SearchRequest.personalization_spec]
 are set.
 [SearchRequest.personalization_spec][google.cloud.retail.v2alpha.SearchRequest.personalization_spec]
 will override
 [ServingConfig.personalization_spec][google.cloud.retail.v2alpha.ServingConfig.personalization_spec].
      .google.cloud.retail.v2alpha.SearchRequest.PersonalizationSpec personalization_spec = 32;
      Returns:
      Whether the personalizationSpec field is set.

    • getPersonalizationSpec

      SearchRequest.PersonalizationSpec getPersonalizationSpec()
       The specification for personalization.

 Notice that if both
 [ServingConfig.personalization_spec][google.cloud.retail.v2alpha.ServingConfig.personalization_spec]
 and
 [SearchRequest.personalization_spec][google.cloud.retail.v2alpha.SearchRequest.personalization_spec]
 are set.
 [SearchRequest.personalization_spec][google.cloud.retail.v2alpha.SearchRequest.personalization_spec]
 will override
 [ServingConfig.personalization_spec][google.cloud.retail.v2alpha.ServingConfig.personalization_spec].
      .google.cloud.retail.v2alpha.SearchRequest.PersonalizationSpec personalization_spec = 32;
      Returns:
      The personalizationSpec.

    • getPersonalizationSpecOrBuilder

      SearchRequest.PersonalizationSpecOrBuilder getPersonalizationSpecOrBuilder()
       The specification for personalization.

 Notice that if both
 [ServingConfig.personalization_spec][google.cloud.retail.v2alpha.ServingConfig.personalization_spec]
 and
 [SearchRequest.personalization_spec][google.cloud.retail.v2alpha.SearchRequest.personalization_spec]
 are set.
 [SearchRequest.personalization_spec][google.cloud.retail.v2alpha.SearchRequest.personalization_spec]
 will override
 [ServingConfig.personalization_spec][google.cloud.retail.v2alpha.ServingConfig.personalization_spec].
      .google.cloud.retail.v2alpha.SearchRequest.PersonalizationSpec personalization_spec = 32;

    • getLabelsCount

      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.

 For more information, see [Requirements for
 labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 in the Resource Manager documentation.
      map<string, string> labels = 34;

    • containsLabels

      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.

 For more information, see [Requirements for
 labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 in the Resource Manager documentation.
      map<string, string> labels = 34;

    • getLabels

      @Deprecated Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.

    • getLabelsMap

      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.

 For more information, see [Requirements for
 labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 in the Resource Manager documentation.
      map<string, string> labels = 34;

    • getLabelsOrDefault

      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.

 For more information, see [Requirements for
 labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 in the Resource Manager documentation.
      map<string, string> labels = 34;

    • getLabelsOrThrow

      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.

 For more information, see [Requirements for
 labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 in the Resource Manager documentation.
      map<string, string> labels = 34;

    • hasSpellCorrectionSpec

      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:
      Whether the spellCorrectionSpec field is set.

    • getSpellCorrectionSpec

      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:
      The spellCorrectionSpec.

    • getSpellCorrectionSpecOrBuilder

      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;

    • getEntity

      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][google.cloud.retail.v2alpha.UserEvent.entity] to get
 search results boosted by entity.
      string entity = 38;
      Returns:
      The entity.

    • getEntityBytes

      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.
 If this is set, it should be exactly matched with
 [UserEvent.entity][google.cloud.retail.v2alpha.UserEvent.entity] to get
 search results boosted by entity.
      string entity = 38;
      Returns:
      The bytes for entity.

    • hasConversationalSearchSpec

      boolean hasConversationalSearchSpec()
       Optional. This field specifies all conversational related parameters
 addition to traditional retail search.
      .google.cloud.retail.v2alpha.SearchRequest.ConversationalSearchSpec conversational_search_spec = 40 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the conversationalSearchSpec field is set.

    • getConversationalSearchSpec

      SearchRequest.ConversationalSearchSpec getConversationalSearchSpec()
       Optional. This field specifies all conversational related parameters
 addition to traditional retail search.
      .google.cloud.retail.v2alpha.SearchRequest.ConversationalSearchSpec conversational_search_spec = 40 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The conversationalSearchSpec.

    • getConversationalSearchSpecOrBuilder

      SearchRequest.ConversationalSearchSpecOrBuilder getConversationalSearchSpecOrBuilder()
       Optional. This field specifies all conversational related parameters
 addition to traditional retail search.
      .google.cloud.retail.v2alpha.SearchRequest.ConversationalSearchSpec conversational_search_spec = 40 [(.google.api.field_behavior) = OPTIONAL];

    • hasTileNavigationSpec

      boolean hasTileNavigationSpec()
       Optional. This field specifies tile navigation related parameters.
      .google.cloud.retail.v2alpha.SearchRequest.TileNavigationSpec tile_navigation_spec = 41 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the tileNavigationSpec field is set.

    • getTileNavigationSpec

      SearchRequest.TileNavigationSpec getTileNavigationSpec()
       Optional. This field specifies tile navigation related parameters.
      .google.cloud.retail.v2alpha.SearchRequest.TileNavigationSpec tile_navigation_spec = 41 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The tileNavigationSpec.

    • getTileNavigationSpecOrBuilder

      SearchRequest.TileNavigationSpecOrBuilder getTileNavigationSpecOrBuilder()
       Optional. This field specifies tile navigation related parameters.
      .google.cloud.retail.v2alpha.SearchRequest.TileNavigationSpec tile_navigation_spec = 41 [(.google.api.field_behavior) = OPTIONAL];

    • getLanguageCode

      String getLanguageCode()
       Optional. The BCP-47 language code, such as "en-US" or "sr-Latn"
 [list](https://www.unicode.org/cldr/charts/46/summary/root.html). For more
 information, see [Standardized codes](https://google.aip.dev/143). This
 field helps to better interpret the query. If a value isn't specified, the
 query language code is automatically detected, which may not be accurate.
      string language_code = 43 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The languageCode.

    • getLanguageCodeBytes

      com.google.protobuf.ByteString getLanguageCodeBytes()
       Optional. The BCP-47 language code, such as "en-US" or "sr-Latn"
 [list](https://www.unicode.org/cldr/charts/46/summary/root.html). For more
 information, see [Standardized codes](https://google.aip.dev/143). This
 field helps to better interpret the query. If a value isn't specified, the
 query language code is automatically detected, which may not be accurate.
      string language_code = 43 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for languageCode.

    • getRegionCode

      String getRegionCode()
       Optional. The Unicode country/region code (CLDR) of a location, such as
 "US" and "419"
 [list](https://www.unicode.org/cldr/charts/46/supplemental/territory_information.html).
 For more information, see [Standardized codes](https://google.aip.dev/143).
 If set, then results will be boosted based on the region_code provided.
      string region_code = 44 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The regionCode.

    • getRegionCodeBytes

      com.google.protobuf.ByteString getRegionCodeBytes()
       Optional. The Unicode country/region code (CLDR) of a location, such as
 "US" and "419"
 [list](https://www.unicode.org/cldr/charts/46/supplemental/territory_information.html).
 For more information, see [Standardized codes](https://google.aip.dev/143).
 If set, then results will be boosted based on the region_code provided.
      string region_code = 44 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for regionCode.

    • getPlaceId

      String getPlaceId()
       Optional. An id corresponding to a place, such as a store id or region id.
 When specified, we use the price from the local inventory with the matching
 product's
 [LocalInventory.place_id][google.cloud.retail.v2alpha.LocalInventory.place_id]
 for revenue optimization.
      string place_id = 46 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The placeId.

    • getPlaceIdBytes

      com.google.protobuf.ByteString getPlaceIdBytes()
       Optional. An id corresponding to a place, such as a store id or region id.
 When specified, we use the price from the local inventory with the matching
 product's
 [LocalInventory.place_id][google.cloud.retail.v2alpha.LocalInventory.place_id]
 for revenue optimization.
      string place_id = 46 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for placeId.

    • getUserAttributesCount

      int getUserAttributesCount()
       Optional. The user attributes that could be used for personalization of
 search results.
 * Populate at most 100 key-value pairs per query.
 * Only supports string keys and repeated string values.
 * Duplicate keys are not allowed within a single query.

 Example:
 user_attributes: [
 { key: "pets"
 value {
 values: "dog"
 values: "cat"
 }
 },
 { key: "state"
 value {
 values: "CA"
 }
 }
 ]
      map<string, .google.cloud.retail.v2alpha.StringList> user_attributes = 47 [(.google.api.field_behavior) = OPTIONAL];

    • containsUserAttributes

      boolean containsUserAttributes(String key)
       Optional. The user attributes that could be used for personalization of
 search results.
 * Populate at most 100 key-value pairs per query.
 * Only supports string keys and repeated string values.
 * Duplicate keys are not allowed within a single query.

 Example:
 user_attributes: [
 { key: "pets"
 value {
 values: "dog"
 values: "cat"
 }
 },
 { key: "state"
 value {
 values: "CA"
 }
 }
 ]
      map<string, .google.cloud.retail.v2alpha.StringList> user_attributes = 47 [(.google.api.field_behavior) = OPTIONAL];

    • getUserAttributes

      @Deprecated Map<String,StringList> getUserAttributes()
      Deprecated.
      Use getUserAttributesMap() instead.

    • getUserAttributesMap

      Map<String,StringList> getUserAttributesMap()
       Optional. The user attributes that could be used for personalization of
 search results.
 * Populate at most 100 key-value pairs per query.
 * Only supports string keys and repeated string values.
 * Duplicate keys are not allowed within a single query.

 Example:
 user_attributes: [
 { key: "pets"
 value {
 values: "dog"
 values: "cat"
 }
 },
 { key: "state"
 value {
 values: "CA"
 }
 }
 ]
      map<string, .google.cloud.retail.v2alpha.StringList> user_attributes = 47 [(.google.api.field_behavior) = OPTIONAL];

    • getUserAttributesOrDefault

      StringList getUserAttributesOrDefault(String key, StringList defaultValue)
       Optional. The user attributes that could be used for personalization of
 search results.
 * Populate at most 100 key-value pairs per query.
 * Only supports string keys and repeated string values.
 * Duplicate keys are not allowed within a single query.

 Example:
 user_attributes: [
 { key: "pets"
 value {
 values: "dog"
 values: "cat"
 }
 },
 { key: "state"
 value {
 values: "CA"
 }
 }
 ]
      map<string, .google.cloud.retail.v2alpha.StringList> user_attributes = 47 [(.google.api.field_behavior) = OPTIONAL];

    • getUserAttributesOrThrow

      StringList getUserAttributesOrThrow(String key)
       Optional. The user attributes that could be used for personalization of
 search results.
 * Populate at most 100 key-value pairs per query.
 * Only supports string keys and repeated string values.
 * Duplicate keys are not allowed within a single query.

 Example:
 user_attributes: [
 { key: "pets"
 value {
 values: "dog"
 values: "cat"
 }
 },
 { key: "state"
 value {
 values: "CA"
 }
 }
 ]
      map<string, .google.cloud.retail.v2alpha.StringList> user_attributes = 47 [(.google.api.field_behavior) = OPTIONAL];