- 2.49.0 (latest)
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.1
- 2.4.0
- 2.3.0
- 2.2.3
- 2.1.0
- 2.0.19
public static final class SearchRequest.Builder extends GeneratedMessageV3.Builder<SearchRequest.Builder> implements SearchRequestOrBuilder
Request message for SearchService.Search method.
Protobuf type google.cloud.retail.v2beta.SearchRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchRequest.BuilderImplements
SearchRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
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 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2beta.SearchRequest.FacetSpec facet_specs = 12;
Parameter | |
---|---|
Name | Description |
values | Iterable<? extends com.google.cloud.retail.v2beta.SearchRequest.FacetSpec> |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
values | Iterable<String> The pageCategories to add. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
values | Iterable<String> The variantRollupKeys to add. |
Returns | |
---|---|
Type | Description |
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 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2beta.SearchRequest.FacetSpec facet_specs = 12;
Parameter | |
---|---|
Name | Description |
value | SearchRequest.FacetSpec |
Returns | |
---|---|
Type | Description |
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 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2beta.SearchRequest.FacetSpec facet_specs = 12;
Parameter | |
---|---|
Name | Description |
builderForValue | SearchRequest.FacetSpec.Builder |
Returns | |
---|---|
Type | Description |
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 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2beta.SearchRequest.FacetSpec facet_specs = 12;
Parameters | |
---|---|
Name | Description |
index | int |
value | SearchRequest.FacetSpec |
Returns | |
---|---|
Type | Description |
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 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2beta.SearchRequest.FacetSpec facet_specs = 12;
Parameters | |
---|---|
Name | Description |
index | int |
builderForValue | SearchRequest.FacetSpec.Builder |
Returns | |
---|---|
Type | Description |
SearchRequest.Builder |
addFacetSpecsBuilder()
public SearchRequest.FacetSpec.Builder addFacetSpecsBuilder()
Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2beta.SearchRequest.FacetSpec facet_specs = 12;
Returns | |
---|---|
Type | Description |
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 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2beta.SearchRequest.FacetSpec facet_specs = 12;
Parameter | |
---|---|
Name | Description |
index | int |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value | String The pageCategories to add. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value | ByteString The bytes of the pageCategories to add. |
Returns | |
---|---|
Type | Description |
SearchRequest.Builder | This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SearchRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
SearchRequest.Builder |
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 | |
---|---|
Name | Description |
value | String The variantRollupKeys to add. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value | ByteString The bytes of the variantRollupKeys to add. |
Returns | |
---|---|
Type | Description |
SearchRequest.Builder | This builder for chaining. |
build()
public SearchRequest build()
Returns | |
---|---|
Type | Description |
SearchRequest |
buildPartial()
public SearchRequest buildPartial()
Returns | |
---|---|
Type | Description |
SearchRequest |
clear()
public SearchRequest.Builder clear()
Returns | |
---|---|
Type | Description |
SearchRequest.Builder |
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.v2beta.SearchRequest.BoostSpec boost_spec = 13;
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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.v2beta.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 21 [deprecated = true];
Returns | |
---|---|
Type | Description |
SearchRequest.Builder |
clearFacetSpecs()
public SearchRequest.Builder clearFacetSpecs()
Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2beta.SearchRequest.FacetSpec facet_specs = 12;
Returns | |
---|---|
Type | Description |
SearchRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public SearchRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field | FieldDescriptor |
Returns | |
---|---|
Type | Description |
SearchRequest.Builder |
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 | |
---|---|
Type | Description |
SearchRequest.Builder | This builder for chaining. |
clearLabels()
public SearchRequest.Builder clearLabels()
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
SearchRequest.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public SearchRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof | OneofDescriptor |
Returns | |
---|---|
Type | Description |
SearchRequest.Builder |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 120. Values above 120 will be coerced to 120. If this field is negative, an INVALID_ARGUMENT is returned.
int32 page_size = 7;
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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.v2beta.SearchRequest.PersonalizationSpec personalization_spec = 32;
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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.v2beta.SearchRequest.QueryExpansionSpec query_expansion_spec = 14;
Returns | |
---|---|
Type | Description |
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.v2beta.SearchRequest.SearchMode search_mode = 31;
Returns | |
---|---|
Type | Description |
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.v2beta.SearchRequest.SpellCorrectionSpec spell_correction_spec = 35;
Returns | |
---|---|
Type | Description |
SearchRequest.Builder |
clearUserInfo()
public SearchRequest.Builder clearUserInfo()
User information.
.google.cloud.retail.v2beta.UserInfo user_info = 5;
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
SearchRequest.Builder | This builder for chaining. |
clone()
public SearchRequest.Builder clone()
Returns | |
---|---|
Type | Description |
SearchRequest.Builder |
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 | |
---|---|
Name | Description |
key | String |
Returns | |
---|---|
Type | Description |
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.v2beta.SearchRequest.BoostSpec boost_spec = 13;
Returns | |
---|---|
Type | Description |
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.v2beta.SearchRequest.BoostSpec boost_spec = 13;
Returns | |
---|---|
Type | Description |
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.v2beta.SearchRequest.BoostSpec boost_spec = 13;
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
ByteString | The bytes for canonicalFilter. |
getDefaultInstanceForType()
public SearchRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
SearchRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getDynamicFacetSpec() (deprecated)
public SearchRequest.DynamicFacetSpec getDynamicFacetSpec()
Deprecated. google.cloud.retail.v2beta.SearchRequest.dynamic_facet_spec is deprecated. See google/cloud/retail/v2beta/search_service.proto;l=586
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.v2beta.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 21 [deprecated = true];
Returns | |
---|---|
Type | Description |
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.v2beta.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 21 [deprecated = true];
Returns | |
---|---|
Type | Description |
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.v2beta.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 21 [deprecated = true];
Returns | |
---|---|
Type | Description |
SearchRequest.DynamicFacetSpecOrBuilder |
getFacetSpecs(int index)
public SearchRequest.FacetSpec getFacetSpecs(int index)
Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2beta.SearchRequest.FacetSpec facet_specs = 12;
Parameter | |
---|---|
Name | Description |
index | int |
Returns | |
---|---|
Type | Description |
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 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2beta.SearchRequest.FacetSpec facet_specs = 12;
Parameter | |
---|---|
Name | Description |
index | int |
Returns | |
---|---|
Type | Description |
SearchRequest.FacetSpec.Builder |
getFacetSpecsBuilderList()
public List<SearchRequest.FacetSpec.Builder> getFacetSpecsBuilderList()
Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2beta.SearchRequest.FacetSpec facet_specs = 12;
Returns | |
---|---|
Type | Description |
List<Builder> |
getFacetSpecsCount()
public int getFacetSpecsCount()
Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2beta.SearchRequest.FacetSpec facet_specs = 12;
Returns | |
---|---|
Type | Description |
int |
getFacetSpecsList()
public List<SearchRequest.FacetSpec> getFacetSpecsList()
Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2beta.SearchRequest.FacetSpec facet_specs = 12;
Returns | |
---|---|
Type | Description |
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 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2beta.SearchRequest.FacetSpec facet_specs = 12;
Parameter | |
---|---|
Name | Description |
index | int |
Returns | |
---|---|
Type | Description |
SearchRequest.FacetSpecOrBuilder |
getFacetSpecsOrBuilderList()
public List<? extends SearchRequest.FacetSpecOrBuilder> getFacetSpecsOrBuilderList()
Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2beta.SearchRequest.FacetSpec facet_specs = 12;
Returns | |
---|---|
Type | Description |
List<? extends com.google.cloud.retail.v2beta.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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
ByteString | The bytes for filter. |
getLabels()
public Map<String,String> getLabels()
Use #getLabelsMap() instead.
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
key | String |
defaultValue | String |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
key | String |
Returns | |
---|---|
Type | Description |
String |
getMutableLabels()
public Map<String,String> getMutableLabels()
Use alternate mutation accessors instead.
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
index | int The index of the element to return. |
Returns | |
---|---|
Type | Description |
String | The pageCategories at the given index. |
getPageCategoriesBytes(int index)
public 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 | |
---|---|
Name | Description |
index | int The index of the value to return. |
Returns | |
---|---|
Type | Description |
ByteString | The bytes of the pageCategories at the given index. |
getPageCategoriesCount()
public 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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 120. Values above 120 will be coerced to 120. If this field is negative, an INVALID_ARGUMENT is returned.
int32 page_size = 7;
Returns | |
---|---|
Type | Description |
int | The pageSize. |
getPageToken()
public String getPageToken()
A page token SearchResponse.next_page_token, received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
string page_token = 8;
Returns | |
---|---|
Type | Description |
String | The pageToken. |
getPageTokenBytes()
public ByteString getPageTokenBytes()
A page token SearchResponse.next_page_token, received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
string page_token = 8;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for pageToken. |
getPersonalizationSpec()
public 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.v2beta.SearchRequest.PersonalizationSpec personalization_spec = 32;
Returns | |
---|---|
Type | Description |
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.v2beta.SearchRequest.PersonalizationSpec personalization_spec = 32;
Returns | |
---|---|
Type | Description |
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.v2beta.SearchRequest.PersonalizationSpec personalization_spec = 32;
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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.v2beta.SearchRequest.QueryExpansionSpec query_expansion_spec = 14;
Returns | |
---|---|
Type | Description |
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.v2beta.SearchRequest.QueryExpansionSpec query_expansion_spec = 14;
Returns | |
---|---|
Type | Description |
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.v2beta.SearchRequest.QueryExpansionSpec query_expansion_spec = 14;
Returns | |
---|---|
Type | Description |
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.v2beta.SearchRequest.SearchMode search_mode = 31;
Returns | |
---|---|
Type | Description |
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.v2beta.SearchRequest.SearchMode search_mode = 31;
Returns | |
---|---|
Type | Description |
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.v2beta.SearchRequest.SpellCorrectionSpec spell_correction_spec = 35;
Returns | |
---|---|
Type | Description |
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.v2beta.SearchRequest.SpellCorrectionSpec spell_correction_spec = 35;
Returns | |
---|---|
Type | Description |
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.v2beta.SearchRequest.SpellCorrectionSpec spell_correction_spec = 35;
Returns | |
---|---|
Type | Description |
SearchRequest.SpellCorrectionSpecOrBuilder |
getUserInfo()
public UserInfo getUserInfo()
User information.
.google.cloud.retail.v2beta.UserInfo user_info = 5;
Returns | |
---|---|
Type | Description |
UserInfo | The userInfo. |
getUserInfoBuilder()
public UserInfo.Builder getUserInfoBuilder()
User information.
.google.cloud.retail.v2beta.UserInfo user_info = 5;
Returns | |
---|---|
Type | Description |
UserInfo.Builder |
getUserInfoOrBuilder()
public UserInfoOrBuilder getUserInfoOrBuilder()
User information.
.google.cloud.retail.v2beta.UserInfo user_info = 5;
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
index | int The index of the element to return. |
Returns | |
---|---|
Type | Description |
String | The variantRollupKeys at the given index. |
getVariantRollupKeysBytes(int index)
public 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 | |
---|---|
Name | Description |
index | int The index of the value to return. |
Returns | |
---|---|
Type | Description |
ByteString | The bytes of the variantRollupKeys at the given index. |
getVariantRollupKeysCount()
public 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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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.v2beta.SearchRequest.BoostSpec boost_spec = 13;
Returns | |
---|---|
Type | Description |
boolean | Whether the boostSpec field is set. |
hasDynamicFacetSpec() (deprecated)
public boolean hasDynamicFacetSpec()
Deprecated. google.cloud.retail.v2beta.SearchRequest.dynamic_facet_spec is deprecated. See google/cloud/retail/v2beta/search_service.proto;l=586
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.v2beta.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 21 [deprecated = true];
Returns | |
---|---|
Type | Description |
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.v2beta.SearchRequest.PersonalizationSpec personalization_spec = 32;
Returns | |
---|---|
Type | Description |
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.v2beta.SearchRequest.QueryExpansionSpec query_expansion_spec = 14;
Returns | |
---|---|
Type | Description |
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.v2beta.SearchRequest.SpellCorrectionSpec spell_correction_spec = 35;
Returns | |
---|---|
Type | Description |
boolean | Whether the spellCorrectionSpec field is set. |
hasUserInfo()
public boolean hasUserInfo()
User information.
.google.cloud.retail.v2beta.UserInfo user_info = 5;
Returns | |
---|---|
Type | Description |
boolean | Whether the userInfo field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter | |
---|---|
Name | Description |
number | int |
Returns | |
---|---|
Type | Description |
MapField |
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)
Parameter | |
---|---|
Name | Description |
number | int |
Returns | |
---|---|
Type | Description |
MapField |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
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.v2beta.SearchRequest.BoostSpec boost_spec = 13;
Parameter | |
---|---|
Name | Description |
value | SearchRequest.BoostSpec |
Returns | |
---|---|
Type | Description |
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.v2beta.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 21 [deprecated = true];
Parameter | |
---|---|
Name | Description |
value | SearchRequest.DynamicFacetSpec |
Returns | |
---|---|
Type | Description |
SearchRequest.Builder |
mergeFrom(SearchRequest other)
public SearchRequest.Builder mergeFrom(SearchRequest other)
Parameter | |
---|---|
Name | Description |
other | SearchRequest |
Returns | |
---|---|
Type | Description |
SearchRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SearchRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SearchRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public SearchRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other | Message |
Returns | |
---|---|
Type | Description |
SearchRequest.Builder |
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.v2beta.SearchRequest.PersonalizationSpec personalization_spec = 32;
Parameter | |
---|---|
Name | Description |
value | SearchRequest.PersonalizationSpec |
Returns | |
---|---|
Type | Description |
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.v2beta.SearchRequest.QueryExpansionSpec query_expansion_spec = 14;
Parameter | |
---|---|
Name | Description |
value | SearchRequest.QueryExpansionSpec |
Returns | |
---|---|
Type | Description |
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.v2beta.SearchRequest.SpellCorrectionSpec spell_correction_spec = 35;
Parameter | |
---|---|
Name | Description |
value | SearchRequest.SpellCorrectionSpec |
Returns | |
---|---|
Type | Description |
SearchRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SearchRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
SearchRequest.Builder |
mergeUserInfo(UserInfo value)
public SearchRequest.Builder mergeUserInfo(UserInfo value)
User information.
.google.cloud.retail.v2beta.UserInfo user_info = 5;
Parameter | |
---|---|
Name | Description |
value | UserInfo |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
values | Map<String,String> |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
key | String |
value | String |
Returns | |
---|---|
Type | Description |
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 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2beta.SearchRequest.FacetSpec facet_specs = 12;
Parameter | |
---|---|
Name | Description |
index | int |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
key | String |
Returns | |
---|---|
Type | Description |
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.v2beta.SearchRequest.BoostSpec boost_spec = 13;
Parameter | |
---|---|
Name | Description |
value | SearchRequest.BoostSpec |
Returns | |
---|---|
Type | Description |
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.v2beta.SearchRequest.BoostSpec boost_spec = 13;
Parameter | |
---|---|
Name | Description |
builderForValue | SearchRequest.BoostSpec.Builder |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value | String The branch to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value | ByteString The bytes for branch to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value | String The canonicalFilter to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value | ByteString The bytes for canonicalFilter to set. |
Returns | |
---|---|
Type | Description |
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.v2beta.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 21 [deprecated = true];
Parameter | |
---|---|
Name | Description |
value | SearchRequest.DynamicFacetSpec |
Returns | |
---|---|
Type | Description |
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.v2beta.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 21 [deprecated = true];
Parameter | |
---|---|
Name | Description |
builderForValue | SearchRequest.DynamicFacetSpec.Builder |
Returns | |
---|---|
Type | Description |
SearchRequest.Builder |
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 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2beta.SearchRequest.FacetSpec facet_specs = 12;
Parameters | |
---|---|
Name | Description |
index | int |
value | SearchRequest.FacetSpec |
Returns | |
---|---|
Type | Description |
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 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2beta.SearchRequest.FacetSpec facet_specs = 12;
Parameters | |
---|---|
Name | Description |
index | int |
builderForValue | SearchRequest.FacetSpec.Builder |
Returns | |
---|---|
Type | Description |
SearchRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public SearchRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
SearchRequest.Builder |
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 | |
---|---|
Name | Description |
value | String The filter to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value | ByteString The bytes for filter to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value | int The offset to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value | String The orderBy to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value | ByteString The bytes for orderBy to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
index | int The index to set the value at. |
value | String The pageCategories to set. |
Returns | |
---|---|
Type | Description |
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 120. Values above 120 will be coerced to 120. If this field is negative, an INVALID_ARGUMENT is returned.
int32 page_size = 7;
Parameter | |
---|---|
Name | Description |
value | int The pageSize to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value | String The pageToken to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value | ByteString The bytes for pageToken to set. |
Returns | |
---|---|
Type | Description |
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.v2beta.SearchRequest.PersonalizationSpec personalization_spec = 32;
Parameter | |
---|---|
Name | Description |
value | SearchRequest.PersonalizationSpec |
Returns | |
---|---|
Type | Description |
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.v2beta.SearchRequest.PersonalizationSpec personalization_spec = 32;
Parameter | |
---|---|
Name | Description |
builderForValue | SearchRequest.PersonalizationSpec.Builder |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value | String The placement to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value | ByteString The bytes for placement to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value | String The query to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value | ByteString The bytes for query to set. |
Returns | |
---|---|
Type | Description |
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.v2beta.SearchRequest.QueryExpansionSpec query_expansion_spec = 14;
Parameter | |
---|---|
Name | Description |
value | SearchRequest.QueryExpansionSpec |
Returns | |
---|---|
Type | Description |
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.v2beta.SearchRequest.QueryExpansionSpec query_expansion_spec = 14;
Parameter | |
---|---|
Name | Description |
builderForValue | SearchRequest.QueryExpansionSpec.Builder |
Returns | |
---|---|
Type | Description |
SearchRequest.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SearchRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Returns | |
---|---|
Type | Description |
SearchRequest.Builder |
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.v2beta.SearchRequest.SearchMode search_mode = 31;
Parameter | |
---|---|
Name | Description |
value | SearchRequest.SearchMode The searchMode to set. |
Returns | |
---|---|
Type | Description |
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.v2beta.SearchRequest.SearchMode search_mode = 31;
Parameter | |
---|---|
Name | Description |
value | int The enum numeric value on the wire for searchMode to set. |
Returns | |
---|---|
Type | Description |
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.v2beta.SearchRequest.SpellCorrectionSpec spell_correction_spec = 35;
Parameter | |
---|---|
Name | Description |
value | SearchRequest.SpellCorrectionSpec |
Returns | |
---|---|
Type | Description |
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.v2beta.SearchRequest.SpellCorrectionSpec spell_correction_spec = 35;
Parameter | |
---|---|
Name | Description |
builderForValue | SearchRequest.SpellCorrectionSpec.Builder |
Returns | |
---|---|
Type | Description |
SearchRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final SearchRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
SearchRequest.Builder |
setUserInfo(UserInfo value)
public SearchRequest.Builder setUserInfo(UserInfo value)
User information.
.google.cloud.retail.v2beta.UserInfo user_info = 5;
Parameter | |
---|---|
Name | Description |
value | UserInfo |
Returns | |
---|---|
Type | Description |
SearchRequest.Builder |
setUserInfo(UserInfo.Builder builderForValue)
public SearchRequest.Builder setUserInfo(UserInfo.Builder builderForValue)
User information.
.google.cloud.retail.v2beta.UserInfo user_info = 5;
Parameter | |
---|---|
Name | Description |
builderForValue | UserInfo.Builder |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
index | int The index to set the value at. |
value | String The variantRollupKeys to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value | String The visitorId to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value | ByteString The bytes for visitorId to set. |
Returns | |
---|---|
Type | Description |
SearchRequest.Builder | This builder for chaining. |