Class SearchRequest.Builder (2.29.0)

public static final class SearchRequest.Builder extends GeneratedMessageV3.Builder<SearchRequest.Builder> implements SearchRequestOrBuilder

Request message for SearchService.Search method.

Protobuf type google.cloud.retail.v2.SearchRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllFacetSpecs(Iterable<? extends SearchRequest.FacetSpec> values)

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.v2.SearchRequest.FacetSpec facet_specs = 12;

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.retail.v2.SearchRequest.FacetSpec>
Returns
TypeDescription
SearchRequest.Builder

addAllPageCategories(Iterable<String> values)

public SearchRequest.Builder addAllPageCategories(Iterable<String> values)

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

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

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

repeated string page_categories = 23;

Parameter
NameDescription
valuesIterable<String>

The pageCategories to add.

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

addAllVariantRollupKeys(Iterable<String> values)

public SearchRequest.Builder addAllVariantRollupKeys(Iterable<String> values)

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

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

Supported keys are:

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

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

repeated string variant_rollup_keys = 17;

Parameter
NameDescription
valuesIterable<String>

The variantRollupKeys to add.

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

addFacetSpecs(SearchRequest.FacetSpec value)

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.v2.SearchRequest.FacetSpec facet_specs = 12;

Parameter
NameDescription
valueSearchRequest.FacetSpec
Returns
TypeDescription
SearchRequest.Builder

addFacetSpecs(SearchRequest.FacetSpec.Builder builderForValue)

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.v2.SearchRequest.FacetSpec facet_specs = 12;

Parameter
NameDescription
builderForValueSearchRequest.FacetSpec.Builder
Returns
TypeDescription
SearchRequest.Builder

addFacetSpecs(int index, SearchRequest.FacetSpec value)

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.v2.SearchRequest.FacetSpec facet_specs = 12;

Parameters
NameDescription
indexint
valueSearchRequest.FacetSpec
Returns
TypeDescription
SearchRequest.Builder

addFacetSpecs(int index, SearchRequest.FacetSpec.Builder builderForValue)

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.v2.SearchRequest.FacetSpec facet_specs = 12;

Parameters
NameDescription
indexint
builderForValueSearchRequest.FacetSpec.Builder
Returns
TypeDescription
SearchRequest.Builder

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.v2.SearchRequest.FacetSpec facet_specs = 12;

Returns
TypeDescription
SearchRequest.FacetSpec.Builder

addFacetSpecsBuilder(int index)

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.v2.SearchRequest.FacetSpec facet_specs = 12;

Parameter
NameDescription
indexint
Returns
TypeDescription
SearchRequest.FacetSpec.Builder

addPageCategories(String value)

public SearchRequest.Builder addPageCategories(String value)

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

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

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

repeated string page_categories = 23;

Parameter
NameDescription
valueString

The pageCategories to add.

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

addPageCategoriesBytes(ByteString value)

public SearchRequest.Builder addPageCategoriesBytes(ByteString value)

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

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

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

repeated string page_categories = 23;

Parameter
NameDescription
valueByteString

The bytes of the pageCategories to add.

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchRequest.Builder
Overrides

addVariantRollupKeys(String value)

public SearchRequest.Builder addVariantRollupKeys(String value)

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

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

Supported keys are:

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

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

repeated string variant_rollup_keys = 17;

Parameter
NameDescription
valueString

The variantRollupKeys to add.

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

addVariantRollupKeysBytes(ByteString value)

public SearchRequest.Builder addVariantRollupKeysBytes(ByteString value)

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

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

Supported keys are:

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

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

repeated string variant_rollup_keys = 17;

Parameter
NameDescription
valueByteString

The bytes of the variantRollupKeys to add.

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

build()

public SearchRequest build()
Returns
TypeDescription
SearchRequest

buildPartial()

public SearchRequest buildPartial()
Returns
TypeDescription
SearchRequest

clear()

public SearchRequest.Builder clear()
Returns
TypeDescription
SearchRequest.Builder
Overrides

clearBoostSpec()

public SearchRequest.Builder clearBoostSpec()

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

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

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

Returns
TypeDescription
SearchRequest.Builder

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

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. For example, if a query does not have enough results, an expanded query with SearchRequest.canonical_filter will be returned as a supplement of the original query. This field is strongly recommended to achieve high search quality.

See SearchRequest.filter for more details about filter syntax.

string canonical_filter = 28;

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

clearDynamicFacetSpec()

public SearchRequest.Builder clearDynamicFacetSpec()

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.v2.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 21 [deprecated = true];

Returns
TypeDescription
SearchRequest.Builder

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 to get search results boosted by entity.

string entity = 38;

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

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.v2.SearchRequest.FacetSpec facet_specs = 12;

Returns
TypeDescription
SearchRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public SearchRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
SearchRequest.Builder
Overrides

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. See more details at this user guide.

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

string filter = 10;

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

clearLabels()

public SearchRequest.Builder clearLabels()
Returns
TypeDescription
SearchRequest.Builder

clearOffset()

public SearchRequest.Builder clearOffset()

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

If this field is negative, an INVALID_ARGUMENT is returned.

int32 offset = 9;

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
SearchRequest.Builder
Overrides

clearOrderBy()

public SearchRequest.Builder clearOrderBy()

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

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

string order_by = 11;

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

clearPageCategories()

public SearchRequest.Builder clearPageCategories()

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

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

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

repeated string page_categories = 23;

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

clearPageSize()

public SearchRequest.Builder clearPageSize()

Maximum number of Products to return. If unspecified, defaults to a reasonable value. The maximum allowed value is

  1. Values above 120 will be coerced to 120.

    If this field is negative, an INVALID_ARGUMENT is returned.

int32 page_size = 7;

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

clearPageToken()

public SearchRequest.Builder clearPageToken()

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

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

string page_token = 8;

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

clearPersonalizationSpec()

public SearchRequest.Builder clearPersonalizationSpec()

The specification for personalization.

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

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

Returns
TypeDescription
SearchRequest.Builder

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

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

Returns
TypeDescription
SearchRequest.Builder

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

string query = 3;

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

clearQueryExpansionSpec()

public SearchRequest.Builder clearQueryExpansionSpec()

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

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

Returns
TypeDescription
SearchRequest.Builder

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.v2.SearchRequest.SearchMode search_mode = 31;

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

clearSpellCorrectionSpec()

public SearchRequest.Builder clearSpellCorrectionSpec()

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

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

Returns
TypeDescription
SearchRequest.Builder

clearUserInfo()

public SearchRequest.Builder clearUserInfo()

User information.

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

Returns
TypeDescription
SearchRequest.Builder

clearVariantRollupKeys()

public SearchRequest.Builder clearVariantRollupKeys()

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

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

Supported keys are:

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

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

repeated string variant_rollup_keys = 17;

Returns
TypeDescription
SearchRequest.Builder

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.

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

This builder for chaining.

clone()

public SearchRequest.Builder clone()
Returns
TypeDescription
SearchRequest.Builder
Overrides

containsLabels(String key)

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.

    See Google Cloud Document for more details.

map<string, string> labels = 34;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getBoostSpec()

public SearchRequest.BoostSpec getBoostSpec()

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

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

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

Returns
TypeDescription
SearchRequest.BoostSpec

The boostSpec.

getBoostSpecBuilder()

public SearchRequest.BoostSpec.Builder getBoostSpecBuilder()

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

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

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

Returns
TypeDescription
SearchRequest.BoostSpec.Builder

getBoostSpecOrBuilder()

public SearchRequest.BoostSpecOrBuilder getBoostSpecOrBuilder()

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

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

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

Returns
TypeDescription
SearchRequest.BoostSpecOrBuilder

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

Returns
TypeDescription
String

The branch.

getBranchBytes()

public ByteString getBranchBytes()

The branch resource name, such as projects/*/locations/global/catalogs/default_catalog/branches/0.

Use "default_branch" as the branch ID or leave this field empty, to search products under the default branch.

string branch = 2 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for branch.

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. For example, if a query does not have enough results, an expanded query with SearchRequest.canonical_filter will be returned as a supplement of the original query. This field is strongly recommended to achieve high search quality.

See SearchRequest.filter for more details about filter syntax.

string canonical_filter = 28;

Returns
TypeDescription
String

The canonicalFilter.

getCanonicalFilterBytes()

public 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. For example, if a query does not have enough results, an expanded query with SearchRequest.canonical_filter will be returned as a supplement of the original query. This field is strongly recommended to achieve high search quality.

See SearchRequest.filter for more details about filter syntax.

string canonical_filter = 28;

Returns
TypeDescription
ByteString

The bytes for canonicalFilter.

getDefaultInstanceForType()

public SearchRequest getDefaultInstanceForType()
Returns
TypeDescription
SearchRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDynamicFacetSpec() (deprecated)

public SearchRequest.DynamicFacetSpec getDynamicFacetSpec()

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

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.v2.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 21 [deprecated = true];

Returns
TypeDescription
SearchRequest.DynamicFacetSpec

The dynamicFacetSpec.

getDynamicFacetSpecBuilder()

public SearchRequest.DynamicFacetSpec.Builder getDynamicFacetSpecBuilder()

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.v2.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 21 [deprecated = true];

Returns
TypeDescription
SearchRequest.DynamicFacetSpec.Builder

getDynamicFacetSpecOrBuilder()

public SearchRequest.DynamicFacetSpecOrBuilder getDynamicFacetSpecOrBuilder()

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

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

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

Returns
TypeDescription
SearchRequest.DynamicFacetSpecOrBuilder

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 to get search results boosted by entity.

string entity = 38;

Returns
TypeDescription
String

The entity.

getEntityBytes()

public 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 to get search results boosted by entity.

string entity = 38;

Returns
TypeDescription
ByteString

The bytes for entity.

getFacetSpecs(int index)

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.v2.SearchRequest.FacetSpec facet_specs = 12;

Parameter
NameDescription
indexint
Returns
TypeDescription
SearchRequest.FacetSpec

getFacetSpecsBuilder(int index)

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.v2.SearchRequest.FacetSpec facet_specs = 12;

Parameter
NameDescription
indexint
Returns
TypeDescription
SearchRequest.FacetSpec.Builder

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.v2.SearchRequest.FacetSpec facet_specs = 12;

Returns
TypeDescription
List<Builder>

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.v2.SearchRequest.FacetSpec facet_specs = 12;

Returns
TypeDescription
int

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.v2.SearchRequest.FacetSpec facet_specs = 12;

Returns
TypeDescription
List<FacetSpec>

getFacetSpecsOrBuilder(int index)

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.v2.SearchRequest.FacetSpec facet_specs = 12;

Parameter
NameDescription
indexint
Returns
TypeDescription
SearchRequest.FacetSpecOrBuilder

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.v2.SearchRequest.FacetSpec facet_specs = 12;

Returns
TypeDescription
List<? extends com.google.cloud.retail.v2.SearchRequest.FacetSpecOrBuilder>

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. See more details at this user guide.

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

string filter = 10;

Returns
TypeDescription
String

The filter.

getFilterBytes()

public 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. See more details at this user guide.

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

string filter = 10;

Returns
TypeDescription
ByteString

The bytes for filter.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

The labels applied to a resource must meet the following requirements:

  • Each resource can have multiple labels, up to a maximum of 64.
  • Each label must be a key-value pair.
  • Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
  • Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
  • The key portion of a label must be unique. However, you can use the same key with multiple resources.
  • Keys must start with a lowercase letter or international character.

    See Google Cloud Document for more details.

map<string, string> labels = 34;

Returns
TypeDescription
int

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.

    See Google Cloud Document for more details.

map<string, string> labels = 34;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

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.

    See Google Cloud Document for more details.

map<string, string> labels = 34;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

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.

    See Google Cloud Document for more details.

map<string, string> labels = 34;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getMutableLabels()

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getOffset()

public int getOffset()

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

If this field is negative, an INVALID_ARGUMENT is returned.

int32 offset = 9;

Returns
TypeDescription
int

The offset.

getOrderBy()

public String getOrderBy()

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

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

string order_by = 11;

Returns
TypeDescription
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

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

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

string order_by = 11;

Returns
TypeDescription
ByteString

The bytes for orderBy.

getPageCategories(int index)

public String getPageCategories(int index)

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

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

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

repeated string page_categories = 23;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The pageCategories at the given index.

getPageCategoriesBytes(int index)

public ByteString getPageCategoriesBytes(int index)

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

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

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

repeated string page_categories = 23;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the pageCategories at the given index.

getPageCategoriesCount()

public int getPageCategoriesCount()

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

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

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

repeated string page_categories = 23;

Returns
TypeDescription
int

The count of pageCategories.

getPageCategoriesList()

public ProtocolStringList getPageCategoriesList()

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

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

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

repeated string page_categories = 23;

Returns
TypeDescription
ProtocolStringList

A list containing the pageCategories.

getPageSize()

public int getPageSize()

Maximum number of Products to return. If unspecified, defaults to a reasonable value. The maximum allowed value is

  1. Values above 120 will be coerced to 120.

    If this field is negative, an INVALID_ARGUMENT is returned.

int32 page_size = 7;

Returns
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

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

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

string page_token = 8;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

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

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

string page_token = 8;

Returns
TypeDescription
ByteString

The bytes for pageToken.

getPersonalizationSpec()

public SearchRequest.PersonalizationSpec getPersonalizationSpec()

The specification for personalization.

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

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

Returns
TypeDescription
SearchRequest.PersonalizationSpec

The personalizationSpec.

getPersonalizationSpecBuilder()

public SearchRequest.PersonalizationSpec.Builder getPersonalizationSpecBuilder()

The specification for personalization.

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

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

Returns
TypeDescription
SearchRequest.PersonalizationSpec.Builder

getPersonalizationSpecOrBuilder()

public SearchRequest.PersonalizationSpecOrBuilder getPersonalizationSpecOrBuilder()

The specification for personalization.

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

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

Returns
TypeDescription
SearchRequest.PersonalizationSpecOrBuilder

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

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

Returns
TypeDescription
String

The placement.

getPlacementBytes()

public 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 will be used to make the search.

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

Returns
TypeDescription
ByteString

The bytes for placement.

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

string query = 3;

Returns
TypeDescription
String

The query.

getQueryBytes()

public ByteString getQueryBytes()

Raw search query.

If this field is empty, the request is considered a category browsing request and returned results are based on filter and page_categories.

string query = 3;

Returns
TypeDescription
ByteString

The bytes for query.

getQueryExpansionSpec()

public SearchRequest.QueryExpansionSpec getQueryExpansionSpec()

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

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

Returns
TypeDescription
SearchRequest.QueryExpansionSpec

The queryExpansionSpec.

getQueryExpansionSpecBuilder()

public SearchRequest.QueryExpansionSpec.Builder getQueryExpansionSpecBuilder()

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

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

Returns
TypeDescription
SearchRequest.QueryExpansionSpec.Builder

getQueryExpansionSpecOrBuilder()

public SearchRequest.QueryExpansionSpecOrBuilder getQueryExpansionSpecOrBuilder()

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

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

Returns
TypeDescription
SearchRequest.QueryExpansionSpecOrBuilder

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.v2.SearchRequest.SearchMode search_mode = 31;

Returns
TypeDescription
SearchRequest.SearchMode

The searchMode.

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.v2.SearchRequest.SearchMode search_mode = 31;

Returns
TypeDescription
int

The enum numeric value on the wire for searchMode.

getSpellCorrectionSpec()

public SearchRequest.SpellCorrectionSpec getSpellCorrectionSpec()

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

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

Returns
TypeDescription
SearchRequest.SpellCorrectionSpec

The spellCorrectionSpec.

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.v2.SearchRequest.SpellCorrectionSpec spell_correction_spec = 35;

Returns
TypeDescription
SearchRequest.SpellCorrectionSpec.Builder

getSpellCorrectionSpecOrBuilder()

public SearchRequest.SpellCorrectionSpecOrBuilder getSpellCorrectionSpecOrBuilder()

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

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

Returns
TypeDescription
SearchRequest.SpellCorrectionSpecOrBuilder

getUserInfo()

public UserInfo getUserInfo()

User information.

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

Returns
TypeDescription
UserInfo

The userInfo.

getUserInfoBuilder()

public UserInfo.Builder getUserInfoBuilder()

User information.

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

Returns
TypeDescription
UserInfo.Builder

getUserInfoOrBuilder()

public UserInfoOrBuilder getUserInfoOrBuilder()

User information.

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

Returns
TypeDescription
UserInfoOrBuilder

getVariantRollupKeys(int index)

public String getVariantRollupKeys(int index)

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

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

Supported keys are:

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

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

repeated string variant_rollup_keys = 17;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The variantRollupKeys at the given index.

getVariantRollupKeysBytes(int index)

public ByteString getVariantRollupKeysBytes(int index)

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

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

Supported keys are:

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

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

repeated string variant_rollup_keys = 17;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the variantRollupKeys at the given index.

getVariantRollupKeysCount()

public int getVariantRollupKeysCount()

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

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

Supported keys are:

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

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

repeated string variant_rollup_keys = 17;

Returns
TypeDescription
int

The count of variantRollupKeys.

getVariantRollupKeysList()

public ProtocolStringList getVariantRollupKeysList()

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

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

Supported keys are:

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

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

repeated string variant_rollup_keys = 17;

Returns
TypeDescription
ProtocolStringList

A list containing the variantRollupKeys.

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.

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
TypeDescription
String

The visitorId.

getVisitorIdBytes()

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

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
TypeDescription
ByteString

The bytes for visitorId.

hasBoostSpec()

public boolean hasBoostSpec()

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

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

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

Returns
TypeDescription
boolean

Whether the boostSpec field is set.

hasDynamicFacetSpec() (deprecated)

public boolean hasDynamicFacetSpec()

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

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.v2.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 21 [deprecated = true];

Returns
TypeDescription
boolean

Whether the dynamicFacetSpec field is set.

hasPersonalizationSpec()

public boolean hasPersonalizationSpec()

The specification for personalization.

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

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

Returns
TypeDescription
boolean

Whether the personalizationSpec field is set.

hasQueryExpansionSpec()

public boolean hasQueryExpansionSpec()

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

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

Returns
TypeDescription
boolean

Whether the queryExpansionSpec field is set.

hasSpellCorrectionSpec()

public boolean hasSpellCorrectionSpec()

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

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

Returns
TypeDescription
boolean

Whether the spellCorrectionSpec field is set.

hasUserInfo()

public boolean hasUserInfo()

User information.

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

Returns
TypeDescription
boolean

Whether the userInfo field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeBoostSpec(SearchRequest.BoostSpec value)

public SearchRequest.Builder mergeBoostSpec(SearchRequest.BoostSpec value)

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

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

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

Parameter
NameDescription
valueSearchRequest.BoostSpec
Returns
TypeDescription
SearchRequest.Builder

mergeDynamicFacetSpec(SearchRequest.DynamicFacetSpec value)

public SearchRequest.Builder mergeDynamicFacetSpec(SearchRequest.DynamicFacetSpec value)

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.v2.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 21 [deprecated = true];

Parameter
NameDescription
valueSearchRequest.DynamicFacetSpec
Returns
TypeDescription
SearchRequest.Builder

mergeFrom(SearchRequest other)

public SearchRequest.Builder mergeFrom(SearchRequest other)
Parameter
NameDescription
otherSearchRequest
Returns
TypeDescription
SearchRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public SearchRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
SearchRequest.Builder
Overrides

mergePersonalizationSpec(SearchRequest.PersonalizationSpec value)

public SearchRequest.Builder mergePersonalizationSpec(SearchRequest.PersonalizationSpec value)

The specification for personalization.

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

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

Parameter
NameDescription
valueSearchRequest.PersonalizationSpec
Returns
TypeDescription
SearchRequest.Builder

mergeQueryExpansionSpec(SearchRequest.QueryExpansionSpec value)

public SearchRequest.Builder mergeQueryExpansionSpec(SearchRequest.QueryExpansionSpec value)

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

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

Parameter
NameDescription
valueSearchRequest.QueryExpansionSpec
Returns
TypeDescription
SearchRequest.Builder

mergeSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec value)

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.v2.SearchRequest.SpellCorrectionSpec spell_correction_spec = 35;

Parameter
NameDescription
valueSearchRequest.SpellCorrectionSpec
Returns
TypeDescription
SearchRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchRequest.Builder
Overrides

mergeUserInfo(UserInfo value)

public SearchRequest.Builder mergeUserInfo(UserInfo value)

User information.

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

Parameter
NameDescription
valueUserInfo
Returns
TypeDescription
SearchRequest.Builder

putAllLabels(Map<String,String> values)

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.

    See Google Cloud Document for more details.

map<string, string> labels = 34;

Parameter
NameDescription
valuesMap<String,String>
Returns
TypeDescription
SearchRequest.Builder

putLabels(String key, String value)

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.

    See Google Cloud Document for more details.

map<string, string> labels = 34;

Parameters
NameDescription
keyString
valueString
Returns
TypeDescription
SearchRequest.Builder

removeFacetSpecs(int index)

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.v2.SearchRequest.FacetSpec facet_specs = 12;

Parameter
NameDescription
indexint
Returns
TypeDescription
SearchRequest.Builder

removeLabels(String key)

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.

    See Google Cloud Document for more details.

map<string, string> labels = 34;

Parameter
NameDescription
keyString
Returns
TypeDescription
SearchRequest.Builder

setBoostSpec(SearchRequest.BoostSpec value)

public SearchRequest.Builder setBoostSpec(SearchRequest.BoostSpec value)

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

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

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

Parameter
NameDescription
valueSearchRequest.BoostSpec
Returns
TypeDescription
SearchRequest.Builder

setBoostSpec(SearchRequest.BoostSpec.Builder builderForValue)

public SearchRequest.Builder setBoostSpec(SearchRequest.BoostSpec.Builder builderForValue)

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

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

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

Parameter
NameDescription
builderForValueSearchRequest.BoostSpec.Builder
Returns
TypeDescription
SearchRequest.Builder

setBranch(String value)

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

Parameter
NameDescription
valueString

The branch to set.

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

setBranchBytes(ByteString value)

public SearchRequest.Builder setBranchBytes(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) = { ... }

Parameter
NameDescription
valueByteString

The bytes for branch to set.

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

setCanonicalFilter(String value)

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. For example, if a query does not have enough results, an expanded query with SearchRequest.canonical_filter will be returned as a supplement of the original query. This field is strongly recommended to achieve high search quality.

See SearchRequest.filter for more details about filter syntax.

string canonical_filter = 28;

Parameter
NameDescription
valueString

The canonicalFilter to set.

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

setCanonicalFilterBytes(ByteString value)

public SearchRequest.Builder setCanonicalFilterBytes(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. For example, if a query does not have enough results, an expanded query with SearchRequest.canonical_filter will be returned as a supplement of the original query. This field is strongly recommended to achieve high search quality.

See SearchRequest.filter for more details about filter syntax.

string canonical_filter = 28;

Parameter
NameDescription
valueByteString

The bytes for canonicalFilter to set.

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

setDynamicFacetSpec(SearchRequest.DynamicFacetSpec value)

public SearchRequest.Builder setDynamicFacetSpec(SearchRequest.DynamicFacetSpec value)

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.v2.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 21 [deprecated = true];

Parameter
NameDescription
valueSearchRequest.DynamicFacetSpec
Returns
TypeDescription
SearchRequest.Builder

setDynamicFacetSpec(SearchRequest.DynamicFacetSpec.Builder builderForValue)

public SearchRequest.Builder setDynamicFacetSpec(SearchRequest.DynamicFacetSpec.Builder builderForValue)

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.v2.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 21 [deprecated = true];

Parameter
NameDescription
builderForValueSearchRequest.DynamicFacetSpec.Builder
Returns
TypeDescription
SearchRequest.Builder

setEntity(String value)

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 to get search results boosted by entity.

string entity = 38;

Parameter
NameDescription
valueString

The entity to set.

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

setEntityBytes(ByteString value)

public SearchRequest.Builder setEntityBytes(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 to get search results boosted by entity.

string entity = 38;

Parameter
NameDescription
valueByteString

The bytes for entity to set.

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

setFacetSpecs(int index, SearchRequest.FacetSpec value)

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.v2.SearchRequest.FacetSpec facet_specs = 12;

Parameters
NameDescription
indexint
valueSearchRequest.FacetSpec
Returns
TypeDescription
SearchRequest.Builder

setFacetSpecs(int index, SearchRequest.FacetSpec.Builder builderForValue)

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.v2.SearchRequest.FacetSpec facet_specs = 12;

Parameters
NameDescription
indexint
builderForValueSearchRequest.FacetSpec.Builder
Returns
TypeDescription
SearchRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public SearchRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchRequest.Builder
Overrides

setFilter(String value)

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. See more details at this user guide.

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

string filter = 10;

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public SearchRequest.Builder setFilterBytes(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. See more details at this user guide.

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

string filter = 10;

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

setOffset(int value)

public SearchRequest.Builder setOffset(int value)

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

If this field is negative, an INVALID_ARGUMENT is returned.

int32 offset = 9;

Parameter
NameDescription
valueint

The offset to set.

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

setOrderBy(String value)

public SearchRequest.Builder setOrderBy(String value)

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

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

string order_by = 11;

Parameter
NameDescription
valueString

The orderBy to set.

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public SearchRequest.Builder setOrderByBytes(ByteString value)

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

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

string order_by = 11;

Parameter
NameDescription
valueByteString

The bytes for orderBy to set.

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

setPageCategories(int index, String value)

public SearchRequest.Builder setPageCategories(int index, String value)

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

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

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

repeated string page_categories = 23;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The pageCategories to set.

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

setPageSize(int value)

public SearchRequest.Builder setPageSize(int value)

Maximum number of Products to return. If unspecified, defaults to a reasonable value. The maximum allowed value is

  1. Values above 120 will be coerced to 120.

    If this field is negative, an INVALID_ARGUMENT is returned.

int32 page_size = 7;

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

setPageToken(String value)

public SearchRequest.Builder setPageToken(String value)

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

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

string page_token = 8;

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public SearchRequest.Builder setPageTokenBytes(ByteString value)

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

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

string page_token = 8;

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

setPersonalizationSpec(SearchRequest.PersonalizationSpec value)

public SearchRequest.Builder setPersonalizationSpec(SearchRequest.PersonalizationSpec value)

The specification for personalization.

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

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

Parameter
NameDescription
valueSearchRequest.PersonalizationSpec
Returns
TypeDescription
SearchRequest.Builder

setPersonalizationSpec(SearchRequest.PersonalizationSpec.Builder builderForValue)

public SearchRequest.Builder setPersonalizationSpec(SearchRequest.PersonalizationSpec.Builder builderForValue)

The specification for personalization.

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

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

Parameter
NameDescription
builderForValueSearchRequest.PersonalizationSpec.Builder
Returns
TypeDescription
SearchRequest.Builder

setPlacement(String value)

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

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

Parameter
NameDescription
valueString

The placement to set.

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

setPlacementBytes(ByteString value)

public SearchRequest.Builder setPlacementBytes(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 will be used to make the search.

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

Parameter
NameDescription
valueByteString

The bytes for placement to set.

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

setQuery(String value)

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

string query = 3;

Parameter
NameDescription
valueString

The query to set.

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

setQueryBytes(ByteString value)

public SearchRequest.Builder setQueryBytes(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 and page_categories.

string query = 3;

Parameter
NameDescription
valueByteString

The bytes for query to set.

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

setQueryExpansionSpec(SearchRequest.QueryExpansionSpec value)

public SearchRequest.Builder setQueryExpansionSpec(SearchRequest.QueryExpansionSpec value)

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

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

Parameter
NameDescription
valueSearchRequest.QueryExpansionSpec
Returns
TypeDescription
SearchRequest.Builder

setQueryExpansionSpec(SearchRequest.QueryExpansionSpec.Builder builderForValue)

public SearchRequest.Builder setQueryExpansionSpec(SearchRequest.QueryExpansionSpec.Builder builderForValue)

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

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

Parameter
NameDescription
builderForValueSearchRequest.QueryExpansionSpec.Builder
Returns
TypeDescription
SearchRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SearchRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
SearchRequest.Builder
Overrides

setSearchMode(SearchRequest.SearchMode value)

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.v2.SearchRequest.SearchMode search_mode = 31;

Parameter
NameDescription
valueSearchRequest.SearchMode

The searchMode to set.

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

setSearchModeValue(int value)

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.v2.SearchRequest.SearchMode search_mode = 31;

Parameter
NameDescription
valueint

The enum numeric value on the wire for searchMode to set.

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec value)

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.v2.SearchRequest.SpellCorrectionSpec spell_correction_spec = 35;

Parameter
NameDescription
valueSearchRequest.SpellCorrectionSpec
Returns
TypeDescription
SearchRequest.Builder

setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec.Builder builderForValue)

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.v2.SearchRequest.SpellCorrectionSpec spell_correction_spec = 35;

Parameter
NameDescription
builderForValueSearchRequest.SpellCorrectionSpec.Builder
Returns
TypeDescription
SearchRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchRequest.Builder
Overrides

setUserInfo(UserInfo value)

public SearchRequest.Builder setUserInfo(UserInfo value)

User information.

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

Parameter
NameDescription
valueUserInfo
Returns
TypeDescription
SearchRequest.Builder

setUserInfo(UserInfo.Builder builderForValue)

public SearchRequest.Builder setUserInfo(UserInfo.Builder builderForValue)

User information.

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

Parameter
NameDescription
builderForValueUserInfo.Builder
Returns
TypeDescription
SearchRequest.Builder

setVariantRollupKeys(int index, String value)

public SearchRequest.Builder setVariantRollupKeys(int index, String value)

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

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

Supported keys are:

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

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

repeated string variant_rollup_keys = 17;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The variantRollupKeys to set.

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

setVisitorId(String value)

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.

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

Parameter
NameDescription
valueString

The visitorId to set.

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.

setVisitorIdBytes(ByteString value)

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

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

Parameter
NameDescription
valueByteString

The bytes for visitorId to set.

Returns
TypeDescription
SearchRequest.Builder

This builder for chaining.