Class SearchRequest.FacetSpec.FacetKey (2.33.0)

Version 2.33.0

• 2.55.0 (latest)
• 2.54.0
• 2.53.0
• 2.51.0
• 2.50.0
• 2.49.0
• 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.FacetSpec.FacetKey extends GeneratedMessageV3 implements SearchRequest.FacetSpec.FacetKeyOrBuilder

Specifies how a facet is computed.

Protobuf type google.cloud.retail.v2alpha.SearchRequest.FacetSpec.FacetKey

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SearchRequest.FacetSpec.FacetKey

Implements

SearchRequest.FacetSpec.FacetKeyOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

CASE_INSENSITIVE_FIELD_NUMBER

public static final int CASE_INSENSITIVE_FIELD_NUMBER

Field Value
Type	Description
int

CONTAINS_FIELD_NUMBER

public static final int CONTAINS_FIELD_NUMBER

Field Value
Type	Description
int

INTERVALS_FIELD_NUMBER

public static final int INTERVALS_FIELD_NUMBER

Field Value
Type	Description
int

KEY_FIELD_NUMBER

public static final int KEY_FIELD_NUMBER

Field Value
Type	Description
int

ORDER_BY_FIELD_NUMBER

public static final int ORDER_BY_FIELD_NUMBER

Field Value
Type	Description
int

PREFIXES_FIELD_NUMBER

public static final int PREFIXES_FIELD_NUMBER

Field Value
Type	Description
int

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER

Field Value
Type	Description
int

RESTRICTED_VALUES_FIELD_NUMBER

public static final int RESTRICTED_VALUES_FIELD_NUMBER

Field Value
Type	Description
int

RETURN_MIN_MAX_FIELD_NUMBER

public static final int RETURN_MIN_MAX_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static SearchRequest.FacetSpec.FacetKey getDefaultInstance()

Returns
Type	Description
SearchRequest.FacetSpec.FacetKey

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static SearchRequest.FacetSpec.FacetKey.Builder newBuilder()

Returns
Type	Description
SearchRequest.FacetSpec.FacetKey.Builder

newBuilder(SearchRequest.FacetSpec.FacetKey prototype)

public static SearchRequest.FacetSpec.FacetKey.Builder newBuilder(SearchRequest.FacetSpec.FacetKey prototype)

Parameter
Name	Description
prototype	SearchRequest.FacetSpec.FacetKey

Returns
Type	Description
SearchRequest.FacetSpec.FacetKey.Builder

parseDelimitedFrom(InputStream input)

public static SearchRequest.FacetSpec.FacetKey parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
SearchRequest.FacetSpec.FacetKey

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.FacetSpec.FacetKey parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchRequest.FacetSpec.FacetKey

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static SearchRequest.FacetSpec.FacetKey parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
SearchRequest.FacetSpec.FacetKey

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.FacetSpec.FacetKey parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchRequest.FacetSpec.FacetKey

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchRequest.FacetSpec.FacetKey parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
SearchRequest.FacetSpec.FacetKey

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.FacetSpec.FacetKey parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchRequest.FacetSpec.FacetKey

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchRequest.FacetSpec.FacetKey parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
SearchRequest.FacetSpec.FacetKey

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.FacetSpec.FacetKey parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchRequest.FacetSpec.FacetKey

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static SearchRequest.FacetSpec.FacetKey parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
SearchRequest.FacetSpec.FacetKey

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.FacetSpec.FacetKey parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchRequest.FacetSpec.FacetKey

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static SearchRequest.FacetSpec.FacetKey parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
SearchRequest.FacetSpec.FacetKey

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.FacetSpec.FacetKey parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchRequest.FacetSpec.FacetKey

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<SearchRequest.FacetSpec.FacetKey> parser()

Returns
Type	Description
Parser<FacetKey>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getCaseInsensitive()

public boolean getCaseInsensitive()

True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.

bool case_insensitive = 10;

Returns
Type	Description
boolean	The caseInsensitive.

getContains(int index)

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

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The contains at the given index.

getContainsBytes(int index)

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

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the contains at the given index.

getContainsCount()

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

Returns
Type	Description
int	The count of contains.

getContainsList()

public ProtocolStringList 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;

Returns
Type	Description
ProtocolStringList	A list containing the contains.

getDefaultInstanceForType()

public SearchRequest.FacetSpec.FacetKey getDefaultInstanceForType()

Returns
Type	Description
SearchRequest.FacetSpec.FacetKey

getIntervals(int index)

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

For all numerical facet keys that appear in the list of products from the catalog, the percentiles 0, 10, 30, 50, 70, 90 and 100 are computed from their distribution weekly. If the model assigns a high score to a numerical facet key and its intervals are not specified in the search request, these percentiles will become the bounds for its intervals and will be returned in the response. If the facet key intervals are specified in the request, then the specified intervals will be returned instead.

repeated .google.cloud.retail.v2alpha.Interval intervals = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
Interval

getIntervalsCount()

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

For all numerical facet keys that appear in the list of products from the catalog, the percentiles 0, 10, 30, 50, 70, 90 and 100 are computed from their distribution weekly. If the model assigns a high score to a numerical facet key and its intervals are not specified in the search request, these percentiles will become the bounds for its intervals and will be returned in the response. If the facet key intervals are specified in the request, then the specified intervals will be returned instead.

repeated .google.cloud.retail.v2alpha.Interval intervals = 2;

Returns
Type	Description
int

getIntervalsList()

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

For all numerical facet keys that appear in the list of products from the catalog, the percentiles 0, 10, 30, 50, 70, 90 and 100 are computed from their distribution weekly. If the model assigns a high score to a numerical facet key and its intervals are not specified in the search request, these percentiles will become the bounds for its intervals and will be returned in the response. If the facet key intervals are specified in the request, then the specified intervals will be returned instead.

repeated .google.cloud.retail.v2alpha.Interval intervals = 2;

Returns
Type	Description
List<Interval>

getIntervalsOrBuilder(int index)

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

For all numerical facet keys that appear in the list of products from the catalog, the percentiles 0, 10, 30, 50, 70, 90 and 100 are computed from their distribution weekly. If the model assigns a high score to a numerical facet key and its intervals are not specified in the search request, these percentiles will become the bounds for its intervals and will be returned in the response. If the facet key intervals are specified in the request, then the specified intervals will be returned instead.

repeated .google.cloud.retail.v2alpha.Interval intervals = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
IntervalOrBuilder

getIntervalsOrBuilderList()

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

For all numerical facet keys that appear in the list of products from the catalog, the percentiles 0, 10, 30, 50, 70, 90 and 100 are computed from their distribution weekly. If the model assigns a high score to a numerical facet key and its intervals are not specified in the search request, these percentiles will become the bounds for its intervals and will be returned in the response. If the facet key intervals are specified in the request, then the specified intervals will be returned instead.

repeated .google.cloud.retail.v2alpha.Interval intervals = 2;

Returns
Type	Description
List<? extends com.google.cloud.retail.v2alpha.IntervalOrBuilder>

getKey()

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

Returns
Type	Description
String	The key.

getKeyBytes()

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

Returns
Type	Description
ByteString	The bytes for key.

getOrderBy()

public String getOrderBy()

The order in which SearchResponse.Facet.values are returned.

Allowed values are:

• "count desc", which means order by SearchResponse.Facet.values.count descending.

• "value desc", which means order by SearchResponse.Facet.values.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;

Returns
Type	Description
String	The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

The order in which SearchResponse.Facet.values are returned.

Allowed values are:

• "count desc", which means order by SearchResponse.Facet.values.count descending.

• "value desc", which means order by SearchResponse.Facet.values.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;

Returns
Type	Description
ByteString	The bytes for orderBy.

getParserForType()

public Parser<SearchRequest.FacetSpec.FacetKey> getParserForType()

Returns
Type	Description
Parser<FacetKey>

Overrides

GeneratedMessageV3.getParserForType()

getPrefixes(int index)

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

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The prefixes at the given index.

getPrefixesBytes(int index)

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

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the prefixes at the given index.

getPrefixesCount()

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

Returns
Type	Description
int	The count of prefixes.

getPrefixesList()

public ProtocolStringList 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;

Returns
Type	Description
ProtocolStringList	A list containing the prefixes.

getQuery()

public 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, SearchResponse.Facet.values.value will be always "1" and SearchResponse.Facet.values.count will be the number of results that match 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;

Returns
Type	Description
String	The query.

getQueryBytes()

public 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, SearchResponse.Facet.values.value will be always "1" and SearchResponse.Facet.values.count will be the number of results that match 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;

Returns
Type	Description
ByteString	The bytes for query.

getRestrictedValues(int index)

public 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 predefined textual fields, custom textual attributes 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;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The restrictedValues at the given index.

getRestrictedValuesBytes(int index)

public 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 predefined textual fields, custom textual attributes 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;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the restrictedValues at the given index.

getRestrictedValuesCount()

public 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 predefined textual fields, custom textual attributes 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;

Returns
Type	Description
int	The count of restrictedValues.

getRestrictedValuesList()

public ProtocolStringList 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 predefined textual fields, custom textual attributes 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;

Returns
Type	Description
ProtocolStringList	A list containing the restrictedValues.

getReturnMinMax()

public boolean getReturnMinMax()

Returns the min and max value for each numerical facet intervals. Ignored for textual facets.

bool return_min_max = 11;

Returns
Type	Description
boolean	The returnMinMax.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public SearchRequest.FacetSpec.FacetKey.Builder newBuilderForType()

Returns
Type	Description
SearchRequest.FacetSpec.FacetKey.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchRequest.FacetSpec.FacetKey.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
SearchRequest.FacetSpec.FacetKey.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public SearchRequest.FacetSpec.FacetKey.Builder toBuilder()

Returns
Type	Description
SearchRequest.FacetSpec.FacetKey.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException