Package com.google.cloud.retail.v2alpha

Class SearchRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.retail.v2alpha.SearchRequest
All Implemented Interfaces:
SearchRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class SearchRequest extends com.google.protobuf.GeneratedMessage implements SearchRequestOrBuilder
 Request message for
 [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search]
 method.
Protobuf type google.cloud.retail.v2alpha.SearchRequest
See Also:

  • Field Details

    • PLACEMENT_FIELD_NUMBER

      public static final int PLACEMENT_FIELD_NUMBER
      See Also:

    • BRANCH_FIELD_NUMBER

      public static final int BRANCH_FIELD_NUMBER
      See Also:

    • QUERY_FIELD_NUMBER

      public static final int QUERY_FIELD_NUMBER
      See Also:

    • VISITOR_ID_FIELD_NUMBER

      public static final int VISITOR_ID_FIELD_NUMBER
      See Also:

    • USER_INFO_FIELD_NUMBER

      public static final int USER_INFO_FIELD_NUMBER
      See Also:

    • PAGE_SIZE_FIELD_NUMBER

      public static final int PAGE_SIZE_FIELD_NUMBER
      See Also:

    • PAGE_TOKEN_FIELD_NUMBER

      public static final int PAGE_TOKEN_FIELD_NUMBER
      See Also:

    • OFFSET_FIELD_NUMBER

      public static final int OFFSET_FIELD_NUMBER
      See Also:

    • FILTER_FIELD_NUMBER

      public static final int FILTER_FIELD_NUMBER
      See Also:

    • CANONICAL_FILTER_FIELD_NUMBER

      public static final int CANONICAL_FILTER_FIELD_NUMBER
      See Also:

    • ORDER_BY_FIELD_NUMBER

      public static final int ORDER_BY_FIELD_NUMBER
      See Also:

    • FACET_SPECS_FIELD_NUMBER

      public static final int FACET_SPECS_FIELD_NUMBER
      See Also:

    • DYNAMIC_FACET_SPEC_FIELD_NUMBER

      public static final int DYNAMIC_FACET_SPEC_FIELD_NUMBER
      See Also:

    • BOOST_SPEC_FIELD_NUMBER

      public static final int BOOST_SPEC_FIELD_NUMBER
      See Also:

    • QUERY_EXPANSION_SPEC_FIELD_NUMBER

      public static final int QUERY_EXPANSION_SPEC_FIELD_NUMBER
      See Also:

    • RELEVANCE_THRESHOLD_FIELD_NUMBER

      public static final int RELEVANCE_THRESHOLD_FIELD_NUMBER
      See Also:

    • VARIANT_ROLLUP_KEYS_FIELD_NUMBER

      public static final int VARIANT_ROLLUP_KEYS_FIELD_NUMBER
      See Also:

    • EXPERIMENT_ID_FIELD_NUMBER

      public static final int EXPERIMENT_ID_FIELD_NUMBER
      See Also:

    • PAGE_CATEGORIES_FIELD_NUMBER

      public static final int PAGE_CATEGORIES_FIELD_NUMBER
      See Also:

    • SEARCH_MODE_FIELD_NUMBER

      public static final int SEARCH_MODE_FIELD_NUMBER
      See Also:

    • PERSONALIZATION_SPEC_FIELD_NUMBER

      public static final int PERSONALIZATION_SPEC_FIELD_NUMBER
      See Also:

    • LABELS_FIELD_NUMBER

      public static final int LABELS_FIELD_NUMBER
      See Also:

    • SPELL_CORRECTION_SPEC_FIELD_NUMBER

      public static final int SPELL_CORRECTION_SPEC_FIELD_NUMBER
      See Also:

    • ENTITY_FIELD_NUMBER

      public static final int ENTITY_FIELD_NUMBER
      See Also:

    • CONVERSATIONAL_SEARCH_SPEC_FIELD_NUMBER

      public static final int CONVERSATIONAL_SEARCH_SPEC_FIELD_NUMBER
      See Also:

    • TILE_NAVIGATION_SPEC_FIELD_NUMBER

      public static final int TILE_NAVIGATION_SPEC_FIELD_NUMBER
      See Also:

    • LANGUAGE_CODE_FIELD_NUMBER

      public static final int LANGUAGE_CODE_FIELD_NUMBER
      See Also:

    • REGION_CODE_FIELD_NUMBER

      public static final int REGION_CODE_FIELD_NUMBER
      See Also:

    • PLACE_ID_FIELD_NUMBER

      public static final int PLACE_ID_FIELD_NUMBER
      See Also:

    • USER_ATTRIBUTES_FIELD_NUMBER

      public static final int USER_ATTRIBUTES_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getPlacement

      public String getPlacement()
       Required. The resource name of the Retail Search serving config, such as
 `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config`
 or the name of the legacy placement resource, such as
 `projects/*/locations/global/catalogs/default_catalog/placements/default_search`.
 This field is used to identify the serving config name and the set
 of models that are used to make the search.
      string placement = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getPlacement in interface SearchRequestOrBuilder
      Returns:
      The placement.

    • getPlacementBytes

      public com.google.protobuf.ByteString getPlacementBytes()
       Required. The resource name of the Retail Search serving config, such as
 `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config`
 or the name of the legacy placement resource, such as
 `projects/*/locations/global/catalogs/default_catalog/placements/default_search`.
 This field is used to identify the serving config name and the set
 of models that are used to make the search.
      string placement = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getPlacementBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for placement.

    • getBranch

      public String getBranch()
       The branch resource name, such as
 `projects/*/locations/global/catalogs/default_catalog/branches/0`.

 Use "default_branch" as the branch ID or leave this field empty, to search
 products under the default branch.
      string branch = 2 [(.google.api.resource_reference) = { ... }
      Specified by:
      getBranch in interface SearchRequestOrBuilder
      Returns:
      The branch.

    • getBranchBytes

      public com.google.protobuf.ByteString getBranchBytes()
       The branch resource name, such as
 `projects/*/locations/global/catalogs/default_catalog/branches/0`.

 Use "default_branch" as the branch ID or leave this field empty, to search
 products under the default branch.
      string branch = 2 [(.google.api.resource_reference) = { ... }
      Specified by:
      getBranchBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for branch.

    • getQuery

      public String getQuery()
       Raw search query.

 If this field is empty, the request is considered a category browsing
 request and returned results are based on
 [filter][google.cloud.retail.v2alpha.SearchRequest.filter] and
 [page_categories][google.cloud.retail.v2alpha.SearchRequest.page_categories].
      string query = 3;
      Specified by:
      getQuery in interface SearchRequestOrBuilder
      Returns:
      The query.

    • getQueryBytes

      public com.google.protobuf.ByteString getQueryBytes()
       Raw search query.

 If this field is empty, the request is considered a category browsing
 request and returned results are based on
 [filter][google.cloud.retail.v2alpha.SearchRequest.filter] and
 [page_categories][google.cloud.retail.v2alpha.SearchRequest.page_categories].
      string query = 3;
      Specified by:
      getQueryBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for query.

    • getVisitorId

      public String getVisitorId()
       Required. A unique identifier for tracking visitors. For example, this
 could be implemented with an HTTP cookie, which should be able to uniquely
 identify a visitor on a single device. This unique identifier should not
 change if the visitor logs in or out of the website.

 This should be the same identifier as
 [UserEvent.visitor_id][google.cloud.retail.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];
      Specified by:
      getVisitorId in interface SearchRequestOrBuilder
      Returns:
      The visitorId.

    • getVisitorIdBytes

      public com.google.protobuf.ByteString getVisitorIdBytes()
       Required. A unique identifier for tracking visitors. For example, this
 could be implemented with an HTTP cookie, which should be able to uniquely
 identify a visitor on a single device. This unique identifier should not
 change if the visitor logs in or out of the website.

 This should be the same identifier as
 [UserEvent.visitor_id][google.cloud.retail.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];
      Specified by:
      getVisitorIdBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for visitorId.

    • hasUserInfo

      public boolean hasUserInfo()
       User information.
      .google.cloud.retail.v2alpha.UserInfo user_info = 5;
      Specified by:
      hasUserInfo in interface SearchRequestOrBuilder
      Returns:
      Whether the userInfo field is set.

    • getUserInfo

      public UserInfo getUserInfo()
       User information.
      .google.cloud.retail.v2alpha.UserInfo user_info = 5;
      Specified by:
      getUserInfo in interface SearchRequestOrBuilder
      Returns:
      The userInfo.

    • getUserInfoOrBuilder

      public UserInfoOrBuilder getUserInfoOrBuilder()
       User information.
      .google.cloud.retail.v2alpha.UserInfo user_info = 5;
      Specified by:
      getUserInfoOrBuilder in interface SearchRequestOrBuilder

    • getPageSize

      public 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;
      Specified by:
      getPageSize in interface SearchRequestOrBuilder
      Returns:
      The pageSize.

    • getPageToken

      public 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;
      Specified by:
      getPageToken in interface SearchRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public com.google.protobuf.ByteString getPageTokenBytes()
       A page token
 [SearchResponse.next_page_token][google.cloud.retail.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;
      Specified by:
      getPageTokenBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • getOffset

      public int getOffset()
       A 0-indexed integer that specifies the current offset (that is, starting
 result location, amongst the
 [Product][google.cloud.retail.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;
      Specified by:
      getOffset in interface SearchRequestOrBuilder
      Returns:
      The offset.

    • getFilter

      public String getFilter()
       The filter syntax consists of an expression language for constructing a
 predicate from one or more fields of the products being filtered. Filter
 expression is case-sensitive. 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;
      Specified by:
      getFilter in interface SearchRequestOrBuilder
      Returns:
      The filter.

    • getFilterBytes

      public com.google.protobuf.ByteString getFilterBytes()
       The filter syntax consists of an expression language for constructing a
 predicate from one or more fields of the products being filtered. Filter
 expression is case-sensitive. 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;
      Specified by:
      getFilterBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for filter.

    • getCanonicalFilter

      public String getCanonicalFilter()
       The default filter that is applied when a user performs a search without
 checking any filters on the search page.

 The filter applied to every search request when quality improvement such as
 query expansion is needed. 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;
      Specified by:
      getCanonicalFilter in interface SearchRequestOrBuilder
      Returns:
      The canonicalFilter.

    • getCanonicalFilterBytes

      public com.google.protobuf.ByteString getCanonicalFilterBytes()
       The default filter that is applied when a user performs a search without
 checking any filters on the search page.

 The filter applied to every search request when quality improvement such as
 query expansion is needed. 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;
      Specified by:
      getCanonicalFilterBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for canonicalFilter.

    • getOrderBy

      public String getOrderBy()
       The order in which products are returned. Products can be ordered by
 a field in an [Product][google.cloud.retail.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;
      Specified by:
      getOrderBy in interface SearchRequestOrBuilder
      Returns:
      The orderBy.

    • getOrderByBytes

      public com.google.protobuf.ByteString getOrderByBytes()
       The order in which products are returned. Products can be ordered by
 a field in an [Product][google.cloud.retail.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;
      Specified by:
      getOrderByBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for orderBy.

    • getFacetSpecsList

      public 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;
      Specified by:
      getFacetSpecsList in interface SearchRequestOrBuilder

    • getFacetSpecsOrBuilderList

      public 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;
      Specified by:
      getFacetSpecsOrBuilderList in interface SearchRequestOrBuilder

    • getFacetSpecsCount

      public 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;
      Specified by:
      getFacetSpecsCount in interface SearchRequestOrBuilder

    • getFacetSpecs

      public 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;
      Specified by:
      getFacetSpecs in interface SearchRequestOrBuilder

    • getFacetSpecsOrBuilder

      public 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;
      Specified by:
      getFacetSpecsOrBuilder in interface SearchRequestOrBuilder

    • hasDynamicFacetSpec

      @Deprecated public 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];
      Specified by:
      hasDynamicFacetSpec in interface SearchRequestOrBuilder
      Returns:
      Whether the dynamicFacetSpec field is set.

    • getDynamicFacetSpec

      @Deprecated public 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];
      Specified by:
      getDynamicFacetSpec in interface SearchRequestOrBuilder
      Returns:
      The dynamicFacetSpec.

    • getDynamicFacetSpecOrBuilder

      @Deprecated public 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];
      Specified by:
      getDynamicFacetSpecOrBuilder in interface SearchRequestOrBuilder

    • hasBoostSpec

      public 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;
      Specified by:
      hasBoostSpec in interface SearchRequestOrBuilder
      Returns:
      Whether the boostSpec field is set.

    • getBoostSpec

      public 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;
      Specified by:
      getBoostSpec in interface SearchRequestOrBuilder
      Returns:
      The boostSpec.

    • getBoostSpecOrBuilder

      public 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;
      Specified by:
      getBoostSpecOrBuilder in interface SearchRequestOrBuilder

    • hasQueryExpansionSpec

      public 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;
      Specified by:
      hasQueryExpansionSpec in interface SearchRequestOrBuilder
      Returns:
      Whether the queryExpansionSpec field is set.

    • getQueryExpansionSpec

      public 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;
      Specified by:
      getQueryExpansionSpec in interface SearchRequestOrBuilder
      Returns:
      The queryExpansionSpec.

    • getQueryExpansionSpecOrBuilder

      public 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;
      Specified by:
      getQueryExpansionSpecOrBuilder in interface SearchRequestOrBuilder

    • getRelevanceThresholdValue

      public 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;
      Specified by:
      getRelevanceThresholdValue in interface SearchRequestOrBuilder
      Returns:
      The enum numeric value on the wire for relevanceThreshold.

    • getRelevanceThreshold

      public 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;
      Specified by:
      getRelevanceThreshold in interface SearchRequestOrBuilder
      Returns:
      The relevanceThreshold.

    • getVariantRollupKeysList

      public com.google.protobuf.ProtocolStringList 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;
      Specified by:
      getVariantRollupKeysList in interface SearchRequestOrBuilder
      Returns:
      A list containing the variantRollupKeys.

    • getVariantRollupKeysCount

      public 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;
      Specified by:
      getVariantRollupKeysCount in interface SearchRequestOrBuilder
      Returns:
      The count of variantRollupKeys.

    • getVariantRollupKeys

      public 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;
      Specified by:
      getVariantRollupKeys in interface SearchRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The variantRollupKeys at the given index.

    • getVariantRollupKeysBytes

      public 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;
      Specified by:
      getVariantRollupKeysBytes in interface SearchRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the variantRollupKeys at the given index.

    • getExperimentId

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

    • getExperimentIdBytes

      public 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];
      Specified by:
      getExperimentIdBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for experimentId.

    • getPageCategoriesList

      public com.google.protobuf.ProtocolStringList 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;
      Specified by:
      getPageCategoriesList in interface SearchRequestOrBuilder
      Returns:
      A list containing the pageCategories.

    • getPageCategoriesCount

      public 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;
      Specified by:
      getPageCategoriesCount in interface SearchRequestOrBuilder
      Returns:
      The count of pageCategories.

    • getPageCategories

      public 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;
      Specified by:
      getPageCategories in interface SearchRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The pageCategories at the given index.

    • getPageCategoriesBytes

      public 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;
      Specified by:
      getPageCategoriesBytes in interface SearchRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the pageCategories at the given index.

    • getSearchModeValue

      public 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;
      Specified by:
      getSearchModeValue in interface SearchRequestOrBuilder
      Returns:
      The enum numeric value on the wire for searchMode.

    • getSearchMode

      public 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;
      Specified by:
      getSearchMode in interface SearchRequestOrBuilder
      Returns:
      The searchMode.

    • hasPersonalizationSpec

      public 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;
      Specified by:
      hasPersonalizationSpec in interface SearchRequestOrBuilder
      Returns:
      Whether the personalizationSpec field is set.

    • getPersonalizationSpec

      public 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;
      Specified by:
      getPersonalizationSpec in interface SearchRequestOrBuilder
      Returns:
      The personalizationSpec.

    • getPersonalizationSpecOrBuilder

      public 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;
      Specified by:
      getPersonalizationSpecOrBuilder in interface SearchRequestOrBuilder

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: SearchRequestOrBuilder
       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;
      Specified by:
      getLabelsCount in interface SearchRequestOrBuilder

    • containsLabels

      public 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;
      Specified by:
      containsLabels in interface SearchRequestOrBuilder

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface SearchRequestOrBuilder

    • getLabelsMap

      public 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;
      Specified by:
      getLabelsMap in interface SearchRequestOrBuilder

    • getLabelsOrDefault

      public 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;
      Specified by:
      getLabelsOrDefault in interface SearchRequestOrBuilder

    • getLabelsOrThrow

      public 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;
      Specified by:
      getLabelsOrThrow in interface SearchRequestOrBuilder

    • hasSpellCorrectionSpec

      public 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;
      Specified by:
      hasSpellCorrectionSpec in interface SearchRequestOrBuilder
      Returns:
      Whether the spellCorrectionSpec field is set.

    • getSpellCorrectionSpec

      public 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;
      Specified by:
      getSpellCorrectionSpec in interface SearchRequestOrBuilder
      Returns:
      The spellCorrectionSpec.

    • getSpellCorrectionSpecOrBuilder

      public 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;
      Specified by:
      getSpellCorrectionSpecOrBuilder in interface SearchRequestOrBuilder

    • getEntity

      public 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;
      Specified by:
      getEntity in interface SearchRequestOrBuilder
      Returns:
      The entity.

    • getEntityBytes

      public 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;
      Specified by:
      getEntityBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for entity.

    • hasConversationalSearchSpec

      public 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];
      Specified by:
      hasConversationalSearchSpec in interface SearchRequestOrBuilder
      Returns:
      Whether the conversationalSearchSpec field is set.

    • getConversationalSearchSpec

      public 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];
      Specified by:
      getConversationalSearchSpec in interface SearchRequestOrBuilder
      Returns:
      The conversationalSearchSpec.

    • getConversationalSearchSpecOrBuilder

      public 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];
      Specified by:
      getConversationalSearchSpecOrBuilder in interface SearchRequestOrBuilder

    • hasTileNavigationSpec

      public 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];
      Specified by:
      hasTileNavigationSpec in interface SearchRequestOrBuilder
      Returns:
      Whether the tileNavigationSpec field is set.

    • getTileNavigationSpec

      public 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];
      Specified by:
      getTileNavigationSpec in interface SearchRequestOrBuilder
      Returns:
      The tileNavigationSpec.

    • getTileNavigationSpecOrBuilder

      public 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];
      Specified by:
      getTileNavigationSpecOrBuilder in interface SearchRequestOrBuilder

    • getLanguageCode

      public 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];
      Specified by:
      getLanguageCode in interface SearchRequestOrBuilder
      Returns:
      The languageCode.

    • getLanguageCodeBytes

      public 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];
      Specified by:
      getLanguageCodeBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for languageCode.

    • getRegionCode

      public 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];
      Specified by:
      getRegionCode in interface SearchRequestOrBuilder
      Returns:
      The regionCode.

    • getRegionCodeBytes

      public 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];
      Specified by:
      getRegionCodeBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for regionCode.

    • getPlaceId

      public 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];
      Specified by:
      getPlaceId in interface SearchRequestOrBuilder
      Returns:
      The placeId.

    • getPlaceIdBytes

      public 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];
      Specified by:
      getPlaceIdBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for placeId.

    • getUserAttributesCount

      public int getUserAttributesCount()
      Description copied from interface: SearchRequestOrBuilder
       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];
      Specified by:
      getUserAttributesCount in interface SearchRequestOrBuilder

    • containsUserAttributes

      public 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];
      Specified by:
      containsUserAttributes in interface SearchRequestOrBuilder

    • getUserAttributes

      @Deprecated public Map<String,StringList> getUserAttributes()
      Deprecated.
      Use getUserAttributesMap() instead.
      Specified by:
      getUserAttributes in interface SearchRequestOrBuilder

    • getUserAttributesMap

      public 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];
      Specified by:
      getUserAttributesMap in interface SearchRequestOrBuilder

    • getUserAttributesOrDefault

      public 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];
      Specified by:
      getUserAttributesOrDefault in interface SearchRequestOrBuilder

    • getUserAttributesOrThrow

      public 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];
      Specified by:
      getUserAttributesOrThrow in interface SearchRequestOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static SearchRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SearchRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SearchRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public SearchRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static SearchRequest.Builder newBuilder()

    • newBuilder

      public static SearchRequest.Builder newBuilder(SearchRequest prototype)

    • toBuilder

      public SearchRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected SearchRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static SearchRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SearchRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<SearchRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public SearchRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder