public static interface SearchRequest.FacetSpec.FacetKeyOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getContains(int index)
public abstract String getContains(int index)Only get facet values that contains the given strings. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "contains" to "Shoe", the "categories" facet will give only "Women > Shoe" and "Men > Shoe". Only supported on textual fields. Maximum is 10.
repeated string contains = 9;
| Name | Description |
| index | intThe index of the element to return. |
| Type | Description |
| String | The contains at the given index. |
getContainsBytes(int index)
public abstract ByteString getContainsBytes(int index)Only get facet values that contains the given strings. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "contains" to "Shoe", the "categories" facet will give only "Women > Shoe" and "Men > Shoe". Only supported on textual fields. Maximum is 10.
repeated string contains = 9;
| Name | Description |
| index | intThe index of the value to return. |
| Type | Description |
| ByteString | The bytes of the contains at the given index. |
getContainsCount()
public abstract int getContainsCount()Only get facet values that contains the given strings. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "contains" to "Shoe", the "categories" facet will give only "Women > Shoe" and "Men > Shoe". Only supported on textual fields. Maximum is 10.
repeated string contains = 9;
| Type | Description |
| int | The count of contains. |
getContainsList()
public abstract List<String> getContainsList()Only get facet values that contains the given strings. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "contains" to "Shoe", the "categories" facet will give only "Women > Shoe" and "Men > Shoe". Only supported on textual fields. Maximum is 10.
repeated string contains = 9;
| Type | Description |
| List<String> | A list containing the contains. |
getIntervals(int index)
public abstract Interval getIntervals(int index)Set only if values should be bucketized into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.
repeated .google.cloud.retail.v2beta.Interval intervals = 2;
| Name | Description |
| index | int |
| Type | Description |
| Interval |
getIntervalsCount()
public abstract int getIntervalsCount()Set only if values should be bucketized into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.
repeated .google.cloud.retail.v2beta.Interval intervals = 2;
| Type | Description |
| int |
getIntervalsList()
public abstract List<Interval> getIntervalsList()Set only if values should be bucketized into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.
repeated .google.cloud.retail.v2beta.Interval intervals = 2;
| Type | Description |
| List<Interval> |
getIntervalsOrBuilder(int index)
public abstract IntervalOrBuilder getIntervalsOrBuilder(int index)Set only if values should be bucketized into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.
repeated .google.cloud.retail.v2beta.Interval intervals = 2;
| Name | Description |
| index | int |
| Type | Description |
| IntervalOrBuilder |
getIntervalsOrBuilderList()
public abstract List<? extends IntervalOrBuilder> getIntervalsOrBuilderList()Set only if values should be bucketized into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.
repeated .google.cloud.retail.v2beta.Interval intervals = 2;
| Type | Description |
| List<? extends com.google.cloud.retail.v2beta.IntervalOrBuilder> |
getKey()
public abstract String getKey()Required. Supported textual and numerical facet keys in Product object, over which the facet values are computed. Facet key is case-sensitive. Allowed facet keys when FacetKey.query is not specified:
- textual_field =
- "brands"
- "categories"
- "genders"
- "ageGroups"
- "availability"
- "colorFamilies"
- "colors"
- "sizes"
- "materials"
- "patterns"
- "conditions"
- "attributes.key"
- "pickupInStore"
- "shipToStore"
- "sameDayDelivery"
- "nextDayDelivery"
- "customFulfillment1"
- "customFulfillment2"
- "customFulfillment3"
- "customFulfillment4"
- "customFulfillment5"
- "inventory(place_id,attributes.key)"
- numerical_field =
- "price"
- "discount"
- "rating"
- "ratingCount"
- "attributes.key"
- "inventory(place_id,price)"
- "inventory(place_id,original_price)"
- "inventory(place_id,attributes.key)"
string key = 1 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| String | The key. |
getKeyBytes()
public abstract ByteString getKeyBytes()Required. Supported textual and numerical facet keys in Product object, over which the facet values are computed. Facet key is case-sensitive. Allowed facet keys when FacetKey.query is not specified:
- textual_field =
- "brands"
- "categories"
- "genders"
- "ageGroups"
- "availability"
- "colorFamilies"
- "colors"
- "sizes"
- "materials"
- "patterns"
- "conditions"
- "attributes.key"
- "pickupInStore"
- "shipToStore"
- "sameDayDelivery"
- "nextDayDelivery"
- "customFulfillment1"
- "customFulfillment2"
- "customFulfillment3"
- "customFulfillment4"
- "customFulfillment5"
- "inventory(place_id,attributes.key)"
- numerical_field =
- "price"
- "discount"
- "rating"
- "ratingCount"
- "attributes.key"
- "inventory(place_id,price)"
- "inventory(place_id,original_price)"
- "inventory(place_id,attributes.key)"
string key = 1 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| ByteString | The bytes for key. |
getOrderBy()
public abstract String getOrderBy()The order in which [Facet.values][] are returned. Allowed values are:
- "count desc", which means order by [Facet.FacetValue.count][] descending.
- "value desc", which means order by [Facet.FacetValue.value][] descending. Only applies to textual facets. If not set, textual values are sorted in natural order; numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals; FulfillmentInfo.place_ids are sorted in the order given by FacetSpec.FacetKey.restricted_values.
string order_by = 4;
| Type | Description |
| String | The orderBy. |
getOrderByBytes()
public abstract ByteString getOrderByBytes()The order in which [Facet.values][] are returned. Allowed values are:
- "count desc", which means order by [Facet.FacetValue.count][] descending.
- "value desc", which means order by [Facet.FacetValue.value][] descending. Only applies to textual facets. If not set, textual values are sorted in natural order; numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals; FulfillmentInfo.place_ids are sorted in the order given by FacetSpec.FacetKey.restricted_values.
string order_by = 4;
| Type | Description |
| ByteString | The bytes for orderBy. |
getPrefixes(int index)
public abstract String getPrefixes(int index)Only get facet values that start with the given string prefix. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "prefixes" to "Women", the "categories" facet will give only "Women > Shoe" and "Women > Dress". Only supported on textual fields. Maximum is 10.
repeated string prefixes = 8;
| Name | Description |
| index | intThe index of the element to return. |
| Type | Description |
| String | The prefixes at the given index. |
getPrefixesBytes(int index)
public abstract ByteString getPrefixesBytes(int index)Only get facet values that start with the given string prefix. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "prefixes" to "Women", the "categories" facet will give only "Women > Shoe" and "Women > Dress". Only supported on textual fields. Maximum is 10.
repeated string prefixes = 8;
| Name | Description |
| index | intThe index of the value to return. |
| Type | Description |
| ByteString | The bytes of the prefixes at the given index. |
getPrefixesCount()
public abstract int getPrefixesCount()Only get facet values that start with the given string prefix. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "prefixes" to "Women", the "categories" facet will give only "Women > Shoe" and "Women > Dress". Only supported on textual fields. Maximum is 10.
repeated string prefixes = 8;
| Type | Description |
| int | The count of prefixes. |
getPrefixesList()
public abstract List<String> getPrefixesList()Only get facet values that start with the given string prefix. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "prefixes" to "Women", the "categories" facet will give only "Women > Shoe" and "Women > Dress". Only supported on textual fields. Maximum is 10.
repeated string prefixes = 8;
| Type | Description |
| List<String> | A list containing the prefixes. |
getQuery()
public abstract String getQuery()The query that is used to compute facet for the given facet key. When provided, it will override the default behavior of facet computation. The query syntax is the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Notice that there is no limitation on FacetKey.key when query is specified. In the response, [FacetValue.value][] will be always "1" and [FacetValue.count][] will be the number of results that matches the query. For example, you can set a customized facet for "shipToStore", where FacetKey.key is "customizedShipToStore", and FacetKey.query is "availability: ANY(\"IN_STOCK\") AND shipToStore: ANY(\"123\")". Then the facet will count the products that are both in stock and ship to store "123".
string query = 5;
| Type | Description |
| String | The query. |
getQueryBytes()
public abstract ByteString getQueryBytes()The query that is used to compute facet for the given facet key. When provided, it will override the default behavior of facet computation. The query syntax is the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Notice that there is no limitation on FacetKey.key when query is specified. In the response, [FacetValue.value][] will be always "1" and [FacetValue.count][] will be the number of results that matches the query. For example, you can set a customized facet for "shipToStore", where FacetKey.key is "customizedShipToStore", and FacetKey.query is "availability: ANY(\"IN_STOCK\") AND shipToStore: ANY(\"123\")". Then the facet will count the products that are both in stock and ship to store "123".
string query = 5;
| Type | Description |
| ByteString | The bytes for query. |
getRestrictedValues(int index)
public abstract String getRestrictedValues(int index)Only get facet for the given restricted values. For example, when using "pickupInStore" as key and set restricted values to ["store123", "store456"], only facets for "store123" and "store456" are returned. Only supported on textual fields and fulfillments. Maximum is 20. Must be set for the fulfillment facet keys:
- pickupInStore
- shipToStore
- sameDayDelivery
- nextDayDelivery
- customFulfillment1
- customFulfillment2
- customFulfillment3
- customFulfillment4
- customFulfillment5
repeated string restricted_values = 3;
| Name | Description |
| index | intThe index of the element to return. |
| Type | Description |
| String | The restrictedValues at the given index. |
getRestrictedValuesBytes(int index)
public abstract ByteString getRestrictedValuesBytes(int index)Only get facet for the given restricted values. For example, when using "pickupInStore" as key and set restricted values to ["store123", "store456"], only facets for "store123" and "store456" are returned. Only supported on textual fields and fulfillments. Maximum is 20. Must be set for the fulfillment facet keys:
- pickupInStore
- shipToStore
- sameDayDelivery
- nextDayDelivery
- customFulfillment1
- customFulfillment2
- customFulfillment3
- customFulfillment4
- customFulfillment5
repeated string restricted_values = 3;
| Name | Description |
| index | intThe index of the value to return. |
| Type | Description |
| ByteString | The bytes of the restrictedValues at the given index. |
getRestrictedValuesCount()
public abstract int getRestrictedValuesCount()Only get facet for the given restricted values. For example, when using "pickupInStore" as key and set restricted values to ["store123", "store456"], only facets for "store123" and "store456" are returned. Only supported on textual fields and fulfillments. Maximum is 20. Must be set for the fulfillment facet keys:
- pickupInStore
- shipToStore
- sameDayDelivery
- nextDayDelivery
- customFulfillment1
- customFulfillment2
- customFulfillment3
- customFulfillment4
- customFulfillment5
repeated string restricted_values = 3;
| Type | Description |
| int | The count of restrictedValues. |
getRestrictedValuesList()
public abstract List<String> getRestrictedValuesList()Only get facet for the given restricted values. For example, when using "pickupInStore" as key and set restricted values to ["store123", "store456"], only facets for "store123" and "store456" are returned. Only supported on textual fields and fulfillments. Maximum is 20. Must be set for the fulfillment facet keys:
- pickupInStore
- shipToStore
- sameDayDelivery
- nextDayDelivery
- customFulfillment1
- customFulfillment2
- customFulfillment3
- customFulfillment4
- customFulfillment5
repeated string restricted_values = 3;
| Type | Description |
| List<String> | A list containing the restrictedValues. |