All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

SearchRequest.FacetSpec.FacetKey, SearchRequest.FacetSpec.FacetKey.Builder

Enclosing class:

SearchRequest.FacetSpec
```
public static interface SearchRequest.FacetSpec.FacetKeyOrBuilder
extends com.google.protobuf.MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`getCaseInsensitive()`	True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
`String`	`getContains(int index)`	Only get facet values that contains the given strings.
`com.google.protobuf.ByteString`	`getContainsBytes(int index)`	Only get facet values that contains the given strings.
`int`	`getContainsCount()`	Only get facet values that contains the given strings.
`List<String>`	`getContainsList()`	Only get facet values that contains the given strings.
`Interval`	`getIntervals(int index)`	Set only if values should be bucketized into intervals.
`int`	`getIntervalsCount()`	Set only if values should be bucketized into intervals.
`List<Interval>`	`getIntervalsList()`	Set only if values should be bucketized into intervals.
`IntervalOrBuilder`	`getIntervalsOrBuilder(int index)`	Set only if values should be bucketized into intervals.
`List<? extends IntervalOrBuilder>`	`getIntervalsOrBuilderList()`	Set only if values should be bucketized into intervals.
`String`	`getKey()`	Required.
`com.google.protobuf.ByteString`	`getKeyBytes()`	Required.
`String`	`getOrderBy()`	The order in which [SearchResponse.Facet.values][google.cloud.retail.v2.SearchResponse.Facet.values] are returned.
`com.google.protobuf.ByteString`	`getOrderByBytes()`	The order in which [SearchResponse.Facet.values][google.cloud.retail.v2.SearchResponse.Facet.values] are returned.
`String`	`getPrefixes(int index)`	Only get facet values that start with the given string prefix.
`com.google.protobuf.ByteString`	`getPrefixesBytes(int index)`	Only get facet values that start with the given string prefix.
`int`	`getPrefixesCount()`	Only get facet values that start with the given string prefix.
`List<String>`	`getPrefixesList()`	Only get facet values that start with the given string prefix.
`String`	`getQuery()`	The query that is used to compute facet for the given facet key.
`com.google.protobuf.ByteString`	`getQueryBytes()`	The query that is used to compute facet for the given facet key.
`String`	`getRestrictedValues(int index)`	Only get facet for the given restricted values.
`com.google.protobuf.ByteString`	`getRestrictedValuesBytes(int index)`	Only get facet for the given restricted values.
`int`	`getRestrictedValuesCount()`	Only get facet for the given restricted values.
`List<String>`	`getRestrictedValuesList()`	Only get facet for the given restricted values.
`boolean`	`getReturnMinMax()`	Returns the min and max value for each numerical facet intervals.

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Detail

getKey

String getKey()

 Required. Supported textual and numerical facet keys in
 [Product][google.cloud.retail.v2.Product] object, over which the facet
 values are computed. Facet key is case-sensitive.

 Allowed facet keys when
 [FacetKey.query][google.cloud.retail.v2.SearchRequest.FacetSpec.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];

Returns:: The key.

getKeyBytes

com.google.protobuf.ByteString getKeyBytes()

 Required. Supported textual and numerical facet keys in
 [Product][google.cloud.retail.v2.Product] object, over which the facet
 values are computed. Facet key is case-sensitive.

 Allowed facet keys when
 [FacetKey.query][google.cloud.retail.v2.SearchRequest.FacetSpec.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];

Returns:: The bytes for key.