Package com.google.cloud.retail.v2alpha

Class SearchRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<SearchRequest.Builder>
com.google.cloud.retail.v2alpha.SearchRequest.Builder
All Implemented Interfaces:
SearchRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
SearchRequest
public static final class SearchRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<SearchRequest.Builder> implements SearchRequestOrBuilder
 Request message for
 [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search]
 method.
Protobuf type google.cloud.retail.v2alpha.SearchRequest

  • 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.Builder<SearchRequest.Builder>

    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<SearchRequest.Builder>

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<SearchRequest.Builder>

    • clear

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<SearchRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public SearchRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchRequest.Builder>

    • mergeFrom

      public SearchRequest.Builder mergeFrom(SearchRequest other)

    • isInitialized

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

    • mergeFrom

      public SearchRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchRequest.Builder>
      Throws:
      IOException

    • 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.

    • setPlacement

      public SearchRequest.Builder setPlacement(String value)
       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];
      Parameters:
      value - The placement to set.
      Returns:
      This builder for chaining.

    • clearPlacement

      public SearchRequest.Builder clearPlacement()
       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:
      This builder for chaining.

    • setPlacementBytes

      public SearchRequest.Builder setPlacementBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for placement to set.
      Returns:
      This builder for chaining.

    • 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.

    • setBranch

      public SearchRequest.Builder setBranch(String value)
       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) = { ... }
      Parameters:
      value - The branch to set.
      Returns:
      This builder for chaining.

    • clearBranch

      public SearchRequest.Builder clearBranch()
       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:
      This builder for chaining.

    • setBranchBytes

      public SearchRequest.Builder setBranchBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for branch to set.
      Returns:
      This builder for chaining.

    • 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.

    • setQuery

      public SearchRequest.Builder setQuery(String value)
       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;
      Parameters:
      value - The query to set.
      Returns:
      This builder for chaining.

    • clearQuery

      public SearchRequest.Builder clearQuery()
       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:
      This builder for chaining.

    • setQueryBytes

      public SearchRequest.Builder setQueryBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for query to set.
      Returns:
      This builder for chaining.

    • 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.

    • setVisitorId

      public SearchRequest.Builder setVisitorId(String value)
       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];
      Parameters:
      value - The visitorId to set.
      Returns:
      This builder for chaining.

    • clearVisitorId

      public SearchRequest.Builder clearVisitorId()
       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:
      This builder for chaining.

    • setVisitorIdBytes

      public SearchRequest.Builder setVisitorIdBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for visitorId to set.
      Returns:
      This builder for chaining.

    • 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.

    • setUserInfo

      public SearchRequest.Builder setUserInfo(UserInfo value)
       User information.
      .google.cloud.retail.v2alpha.UserInfo user_info = 5;

    • setUserInfo

      public SearchRequest.Builder setUserInfo(UserInfo.Builder builderForValue)
       User information.
      .google.cloud.retail.v2alpha.UserInfo user_info = 5;

    • mergeUserInfo

      public SearchRequest.Builder mergeUserInfo(UserInfo value)
       User information.
      .google.cloud.retail.v2alpha.UserInfo user_info = 5;

    • clearUserInfo

      public SearchRequest.Builder clearUserInfo()
       User information.
      .google.cloud.retail.v2alpha.UserInfo user_info = 5;

    • getUserInfoBuilder

      public UserInfo.Builder getUserInfoBuilder()
       User information.
      .google.cloud.retail.v2alpha.UserInfo user_info = 5;

    • 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.

    • setPageSize

      public SearchRequest.Builder setPageSize(int value)
       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;
      Parameters:
      value - The pageSize to set.
      Returns:
      This builder for chaining.

    • clearPageSize

      public SearchRequest.Builder clearPageSize()
       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:
      This builder for chaining.

    • 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.

    • setPageToken

      public SearchRequest.Builder setPageToken(String value)
       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;
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.

    • clearPageToken

      public SearchRequest.Builder clearPageToken()
       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:
      This builder for chaining.

    • setPageTokenBytes

      public SearchRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.

    • 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.

    • setOffset

      public SearchRequest.Builder setOffset(int value)
       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;
      Parameters:
      value - The offset to set.
      Returns:
      This builder for chaining.

    • clearOffset

      public SearchRequest.Builder clearOffset()
       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:
      This builder for chaining.

    • 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.

    • setFilter

      public SearchRequest.Builder setFilter(String value)
       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;
      Parameters:
      value - The filter to set.
      Returns:
      This builder for chaining.

    • clearFilter

      public SearchRequest.Builder clearFilter()
       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:
      This builder for chaining.

    • setFilterBytes

      public SearchRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for filter to set.
      Returns:
      This builder for chaining.

    • 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.

    • setCanonicalFilter

      public SearchRequest.Builder setCanonicalFilter(String value)
       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;
      Parameters:
      value - The canonicalFilter to set.
      Returns:
      This builder for chaining.

    • clearCanonicalFilter

      public SearchRequest.Builder clearCanonicalFilter()
       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:
      This builder for chaining.

    • setCanonicalFilterBytes

      public SearchRequest.Builder setCanonicalFilterBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for canonicalFilter to set.
      Returns:
      This builder for chaining.

    • 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.

    • setOrderBy

      public SearchRequest.Builder setOrderBy(String value)
       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;
      Parameters:
      value - The orderBy to set.
      Returns:
      This builder for chaining.

    • clearOrderBy

      public SearchRequest.Builder clearOrderBy()
       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:
      This builder for chaining.

    • setOrderByBytes

      public SearchRequest.Builder setOrderByBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for orderBy to set.
      Returns:
      This builder for chaining.

    • 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

    • 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

    • setFacetSpecs

      public SearchRequest.Builder setFacetSpecs(int index, SearchRequest.FacetSpec value)
       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;

    • setFacetSpecs

      public SearchRequest.Builder setFacetSpecs(int index, SearchRequest.FacetSpec.Builder builderForValue)
       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;

    • addFacetSpecs

      public SearchRequest.Builder addFacetSpecs(SearchRequest.FacetSpec value)
       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;

    • addFacetSpecs

      public SearchRequest.Builder addFacetSpecs(int index, SearchRequest.FacetSpec value)
       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;

    • addFacetSpecs

      public SearchRequest.Builder addFacetSpecs(SearchRequest.FacetSpec.Builder builderForValue)
       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;

    • addFacetSpecs

      public SearchRequest.Builder addFacetSpecs(int index, SearchRequest.FacetSpec.Builder builderForValue)
       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;

    • addAllFacetSpecs

      public SearchRequest.Builder addAllFacetSpecs(Iterable<? extends SearchRequest.FacetSpec> values)
       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;

    • clearFacetSpecs

      public SearchRequest.Builder clearFacetSpecs()
       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;

    • removeFacetSpecs

      public SearchRequest.Builder removeFacetSpecs(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;

    • getFacetSpecsBuilder

      public SearchRequest.FacetSpec.Builder getFacetSpecsBuilder(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;

    • 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

    • 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

    • addFacetSpecsBuilder

      public SearchRequest.FacetSpec.Builder addFacetSpecsBuilder()
       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;

    • addFacetSpecsBuilder

      public SearchRequest.FacetSpec.Builder addFacetSpecsBuilder(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;

    • getFacetSpecsBuilderList

      public List<SearchRequest.FacetSpec.Builder> getFacetSpecsBuilderList()
       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 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.

    • setDynamicFacetSpec

      @Deprecated public SearchRequest.Builder setDynamicFacetSpec(SearchRequest.DynamicFacetSpec value)
      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];

    • setDynamicFacetSpec

      @Deprecated public SearchRequest.Builder setDynamicFacetSpec(SearchRequest.DynamicFacetSpec.Builder builderForValue)
      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];

    • mergeDynamicFacetSpec

      @Deprecated public SearchRequest.Builder mergeDynamicFacetSpec(SearchRequest.DynamicFacetSpec value)
      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];

    • clearDynamicFacetSpec

      @Deprecated public SearchRequest.Builder clearDynamicFacetSpec()
      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];

    • getDynamicFacetSpecBuilder

      @Deprecated public SearchRequest.DynamicFacetSpec.Builder getDynamicFacetSpecBuilder()
      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];

    • 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.

    • setBoostSpec

      public SearchRequest.Builder setBoostSpec(SearchRequest.BoostSpec value)
       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;

    • setBoostSpec

      public SearchRequest.Builder setBoostSpec(SearchRequest.BoostSpec.Builder builderForValue)
       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;

    • mergeBoostSpec

      public SearchRequest.Builder mergeBoostSpec(SearchRequest.BoostSpec value)
       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;

    • clearBoostSpec

      public SearchRequest.Builder clearBoostSpec()
       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;

    • getBoostSpecBuilder

      public SearchRequest.BoostSpec.Builder getBoostSpecBuilder()
       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;

    • 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.

    • setQueryExpansionSpec

      public SearchRequest.Builder setQueryExpansionSpec(SearchRequest.QueryExpansionSpec value)
       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;

    • setQueryExpansionSpec

      public SearchRequest.Builder setQueryExpansionSpec(SearchRequest.QueryExpansionSpec.Builder builderForValue)
       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;

    • mergeQueryExpansionSpec

      public SearchRequest.Builder mergeQueryExpansionSpec(SearchRequest.QueryExpansionSpec value)
       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;

    • clearQueryExpansionSpec

      public SearchRequest.Builder clearQueryExpansionSpec()
       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;

    • getQueryExpansionSpecBuilder

      public SearchRequest.QueryExpansionSpec.Builder getQueryExpansionSpecBuilder()
       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;

    • 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.

    • setRelevanceThresholdValue

      public SearchRequest.Builder setRelevanceThresholdValue(int value)
       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;
      Parameters:
      value - The enum numeric value on the wire for relevanceThreshold to set.
      Returns:
      This builder for chaining.

    • 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.

    • setRelevanceThreshold

      public SearchRequest.Builder setRelevanceThreshold(SearchRequest.RelevanceThreshold value)
       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;
      Parameters:
      value - The relevanceThreshold to set.
      Returns:
      This builder for chaining.

    • clearRelevanceThreshold

      public SearchRequest.Builder clearRelevanceThreshold()
       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:
      This builder for chaining.

    • 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.

    • setVariantRollupKeys

      public SearchRequest.Builder setVariantRollupKeys(int index, String value)
       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 to set the value at.
      value - The variantRollupKeys to set.
      Returns:
      This builder for chaining.

    • addVariantRollupKeys

      public SearchRequest.Builder addVariantRollupKeys(String value)
       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:
      value - The variantRollupKeys to add.
      Returns:
      This builder for chaining.

    • addAllVariantRollupKeys

      public SearchRequest.Builder addAllVariantRollupKeys(Iterable<String> values)
       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:
      values - The variantRollupKeys to add.
      Returns:
      This builder for chaining.

    • clearVariantRollupKeys

      public SearchRequest.Builder clearVariantRollupKeys()
       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:
      This builder for chaining.

    • addVariantRollupKeysBytes

      public SearchRequest.Builder addVariantRollupKeysBytes(com.google.protobuf.ByteString value)
       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:
      value - The bytes of the variantRollupKeys to add.
      Returns:
      This builder for chaining.

    • 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.

    • setExperimentId

      public SearchRequest.Builder setExperimentId(String value)
       Optional. An ID for the experiment group this search belongs to.
      string experiment_id = 18 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The experimentId to set.
      Returns:
      This builder for chaining.

    • clearExperimentId

      public SearchRequest.Builder clearExperimentId()
       Optional. An ID for the experiment group this search belongs to.
      string experiment_id = 18 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setExperimentIdBytes

      public SearchRequest.Builder setExperimentIdBytes(com.google.protobuf.ByteString value)
       Optional. An ID for the experiment group this search belongs to.
      string experiment_id = 18 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for experimentId to set.
      Returns:
      This builder for chaining.

    • 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.

    • setPageCategories

      public SearchRequest.Builder setPageCategories(int index, String value)
       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 to set the value at.
      value - The pageCategories to set.
      Returns:
      This builder for chaining.

    • addPageCategories

      public SearchRequest.Builder addPageCategories(String value)
       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:
      value - The pageCategories to add.
      Returns:
      This builder for chaining.

    • addAllPageCategories

      public SearchRequest.Builder addAllPageCategories(Iterable<String> values)
       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:
      values - The pageCategories to add.
      Returns:
      This builder for chaining.

    • clearPageCategories

      public SearchRequest.Builder clearPageCategories()
       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:
      This builder for chaining.

    • addPageCategoriesBytes

      public SearchRequest.Builder addPageCategoriesBytes(com.google.protobuf.ByteString value)
       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:
      value - The bytes of the pageCategories to add.
      Returns:
      This builder for chaining.

    • 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.

    • setSearchModeValue

      public SearchRequest.Builder setSearchModeValue(int value)
       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;
      Parameters:
      value - The enum numeric value on the wire for searchMode to set.
      Returns:
      This builder for chaining.

    • 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.

    • setSearchMode

      public SearchRequest.Builder setSearchMode(SearchRequest.SearchMode value)
       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;
      Parameters:
      value - The searchMode to set.
      Returns:
      This builder for chaining.

    • clearSearchMode

      public SearchRequest.Builder clearSearchMode()
       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:
      This builder for chaining.

    • 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.

    • setPersonalizationSpec

      public SearchRequest.Builder setPersonalizationSpec(SearchRequest.PersonalizationSpec value)
       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;

    • setPersonalizationSpec

      public SearchRequest.Builder setPersonalizationSpec(SearchRequest.PersonalizationSpec.Builder builderForValue)
       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;

    • mergePersonalizationSpec

      public SearchRequest.Builder mergePersonalizationSpec(SearchRequest.PersonalizationSpec value)
       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;

    • clearPersonalizationSpec

      public SearchRequest.Builder clearPersonalizationSpec()
       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;

    • getPersonalizationSpecBuilder

      public SearchRequest.PersonalizationSpec.Builder getPersonalizationSpecBuilder()
       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;

    • 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

    • clearLabels

      public SearchRequest.Builder clearLabels()

    • removeLabels

      public SearchRequest.Builder removeLabels(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;

    • getMutableLabels

      @Deprecated public Map<String,String> getMutableLabels()
      Deprecated.
      Use alternate mutation accessors instead.

    • putLabels

      public SearchRequest.Builder putLabels(String key, String value)
       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;

    • putAllLabels

      public SearchRequest.Builder putAllLabels(Map<String,String> values)
       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

      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.

    • setSpellCorrectionSpec

      public SearchRequest.Builder setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec value)
       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;

    • setSpellCorrectionSpec

      public SearchRequest.Builder setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec.Builder builderForValue)
       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;

    • mergeSpellCorrectionSpec

      public SearchRequest.Builder mergeSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec value)
       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;

    • clearSpellCorrectionSpec

      public SearchRequest.Builder clearSpellCorrectionSpec()
       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;

    • getSpellCorrectionSpecBuilder

      public SearchRequest.SpellCorrectionSpec.Builder getSpellCorrectionSpecBuilder()
       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;

    • 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.

    • setEntity

      public SearchRequest.Builder setEntity(String value)
       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;
      Parameters:
      value - The entity to set.
      Returns:
      This builder for chaining.

    • clearEntity

      public SearchRequest.Builder clearEntity()
       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:
      This builder for chaining.

    • setEntityBytes

      public SearchRequest.Builder setEntityBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for entity to set.
      Returns:
      This builder for chaining.

    • 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.

    • setConversationalSearchSpec

      public SearchRequest.Builder setConversationalSearchSpec(SearchRequest.ConversationalSearchSpec value)
       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];

    • setConversationalSearchSpec

      public SearchRequest.Builder setConversationalSearchSpec(SearchRequest.ConversationalSearchSpec.Builder builderForValue)
       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];

    • mergeConversationalSearchSpec

      public SearchRequest.Builder mergeConversationalSearchSpec(SearchRequest.ConversationalSearchSpec value)
       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];

    • clearConversationalSearchSpec

      public SearchRequest.Builder clearConversationalSearchSpec()
       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];

    • getConversationalSearchSpecBuilder

      public SearchRequest.ConversationalSearchSpec.Builder getConversationalSearchSpecBuilder()
       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];

    • 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.

    • setTileNavigationSpec

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

    • setTileNavigationSpec

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

    • mergeTileNavigationSpec

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

    • clearTileNavigationSpec

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

    • getTileNavigationSpecBuilder

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

    • 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.

    • setLanguageCode

      public SearchRequest.Builder setLanguageCode(String value)
       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];
      Parameters:
      value - The languageCode to set.
      Returns:
      This builder for chaining.

    • clearLanguageCode

      public SearchRequest.Builder clearLanguageCode()
       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:
      This builder for chaining.

    • setLanguageCodeBytes

      public SearchRequest.Builder setLanguageCodeBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for languageCode to set.
      Returns:
      This builder for chaining.

    • 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.

    • setRegionCode

      public SearchRequest.Builder setRegionCode(String value)
       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];
      Parameters:
      value - The regionCode to set.
      Returns:
      This builder for chaining.

    • clearRegionCode

      public SearchRequest.Builder clearRegionCode()
       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:
      This builder for chaining.

    • setRegionCodeBytes

      public SearchRequest.Builder setRegionCodeBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for regionCode to set.
      Returns:
      This builder for chaining.

    • 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.

    • setPlaceId

      public SearchRequest.Builder setPlaceId(String value)
       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];
      Parameters:
      value - The placeId to set.
      Returns:
      This builder for chaining.

    • clearPlaceId

      public SearchRequest.Builder clearPlaceId()
       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:
      This builder for chaining.

    • setPlaceIdBytes

      public SearchRequest.Builder setPlaceIdBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for placeId to set.
      Returns:
      This builder for chaining.

    • 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

    • clearUserAttributes

      public SearchRequest.Builder clearUserAttributes()

    • removeUserAttributes

      public SearchRequest.Builder removeUserAttributes(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];

    • getMutableUserAttributes

      @Deprecated public Map<String,StringList> getMutableUserAttributes()
      Deprecated.
      Use alternate mutation accessors instead.

    • putUserAttributes

      public SearchRequest.Builder putUserAttributes(String key, StringList value)
       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];

    • putAllUserAttributes

      public SearchRequest.Builder putAllUserAttributes(Map<String,StringList> values)
       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];

    • putUserAttributesBuilderIfAbsent

      public StringList.Builder putUserAttributesBuilderIfAbsent(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];