com.google.cloud.retail.v2

Class SearchRequest.FacetSpec.FacetKey

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey

All Implemented Interfaces:

SearchRequest.FacetSpec.FacetKeyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

SearchRequest.FacetSpec

public static final class SearchRequest.FacetSpec.FacetKey
extends com.google.protobuf.GeneratedMessageV3
implements SearchRequest.FacetSpec.FacetKeyOrBuilder

 Specifies how a facet is computed.
 

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchRequest.FacetSpec.FacetKey.Builder Specifies how a facet is computed.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CASE_INSENSITIVE_FIELD_NUMBER
static int	CONTAINS_FIELD_NUMBER
static int	INTERVALS_FIELD_NUMBER
static int	KEY_FIELD_NUMBER
static int	ORDER_BY_FIELD_NUMBER
static int	PREFIXES_FIELD_NUMBER
static int	QUERY_FIELD_NUMBER
static int	RESTRICTED_VALUES_FIELD_NUMBER
static int	RETURN_MIN_MAX_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
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.
com.google.protobuf.ProtocolStringList	getContainsList() Only get facet values that contains the given strings.
static SearchRequest.FacetSpec.FacetKey	getDefaultInstance()
SearchRequest.FacetSpec.FacetKey	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.
com.google.protobuf.Parser<SearchRequest.FacetSpec.FacetKey>	getParserForType()
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.
com.google.protobuf.ProtocolStringList	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.
com.google.protobuf.ProtocolStringList	getRestrictedValuesList() Only get facet for the given restricted values.
boolean	getReturnMinMax() Returns the min and max value for each numerical facet intervals.
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static SearchRequest.FacetSpec.FacetKey.Builder	newBuilder()
static SearchRequest.FacetSpec.FacetKey.Builder	newBuilder(SearchRequest.FacetSpec.FacetKey prototype)
SearchRequest.FacetSpec.FacetKey.Builder	newBuilderForType()
protected SearchRequest.FacetSpec.FacetKey.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static SearchRequest.FacetSpec.FacetKey	parseDelimitedFrom(InputStream input)
static SearchRequest.FacetSpec.FacetKey	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.FacetSpec.FacetKey	parseFrom(byte[] data)
static SearchRequest.FacetSpec.FacetKey	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.FacetSpec.FacetKey	parseFrom(ByteBuffer data)
static SearchRequest.FacetSpec.FacetKey	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.FacetSpec.FacetKey	parseFrom(com.google.protobuf.ByteString data)
static SearchRequest.FacetSpec.FacetKey	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.FacetSpec.FacetKey	parseFrom(com.google.protobuf.CodedInputStream input)
static SearchRequest.FacetSpec.FacetKey	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.FacetSpec.FacetKey	parseFrom(InputStream input)
static SearchRequest.FacetSpec.FacetKey	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SearchRequest.FacetSpec.FacetKey>	parser()
SearchRequest.FacetSpec.FacetKey.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

KEY_FIELD_NUMBER

public static final int KEY_FIELD_NUMBER

See Also:

Constant Field Values

INTERVALS_FIELD_NUMBER

public static final int INTERVALS_FIELD_NUMBER

See Also:

Constant Field Values

RESTRICTED_VALUES_FIELD_NUMBER

public static final int RESTRICTED_VALUES_FIELD_NUMBER

See Also:

Constant Field Values

PREFIXES_FIELD_NUMBER

public static final int PREFIXES_FIELD_NUMBER

See Also:

Constant Field Values

CONTAINS_FIELD_NUMBER

public static final int CONTAINS_FIELD_NUMBER

See Also:

Constant Field Values

CASE_INSENSITIVE_FIELD_NUMBER

public static final int CASE_INSENSITIVE_FIELD_NUMBER

See Also:

Constant Field Values

ORDER_BY_FIELD_NUMBER

public static final int ORDER_BY_FIELD_NUMBER

See Also:

Constant Field Values

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER

See Also:

Constant Field Values

RETURN_MIN_MAX_FIELD_NUMBER

public static final int RETURN_MIN_MAX_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getKey

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

Specified by:

getKey in interface SearchRequest.FacetSpec.FacetKeyOrBuilder

Returns:

The key.

getKeyBytes

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

Specified by:

getKeyBytes in interface SearchRequest.FacetSpec.FacetKeyOrBuilder

Returns:

The bytes for key.

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.v2.Interval intervals = 2;

Specified by:

getIntervalsList in interface SearchRequest.FacetSpec.FacetKeyOrBuilder

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.v2.Interval intervals = 2;

Specified by:

getIntervalsOrBuilderList in interface SearchRequest.FacetSpec.FacetKeyOrBuilder

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.v2.Interval intervals = 2;

Specified by:

getIntervalsCount in interface SearchRequest.FacetSpec.FacetKeyOrBuilder

getIntervals

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.v2.Interval intervals = 2;

Specified by:

getIntervals in interface SearchRequest.FacetSpec.FacetKeyOrBuilder

getIntervalsOrBuilder

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.v2.Interval intervals = 2;

Specified by:

getIntervalsOrBuilder in interface SearchRequest.FacetSpec.FacetKeyOrBuilder

getRestrictedValuesList

public com.google.protobuf.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;

Specified by:

getRestrictedValuesList in interface SearchRequest.FacetSpec.FacetKeyOrBuilder

Returns:

A list containing the restrictedValues.

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;

Specified by:

getRestrictedValuesCount in interface SearchRequest.FacetSpec.FacetKeyOrBuilder

Returns:

The count of restrictedValues.

getRestrictedValues

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;

Specified by:

getRestrictedValues in interface SearchRequest.FacetSpec.FacetKeyOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The restrictedValues at the given index.

getRestrictedValuesBytes

public com.google.protobuf.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;

Specified by:

getRestrictedValuesBytes in interface SearchRequest.FacetSpec.FacetKeyOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the restrictedValues at the given index.

getPrefixesList

public com.google.protobuf.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;

Specified by:

getPrefixesList in interface SearchRequest.FacetSpec.FacetKeyOrBuilder

Returns:

A list containing the prefixes.

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;

Specified by:

getPrefixesCount in interface SearchRequest.FacetSpec.FacetKeyOrBuilder

Returns:

The count of prefixes.

getPrefixes

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;

Specified by:

getPrefixes in interface SearchRequest.FacetSpec.FacetKeyOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The prefixes at the given index.

getPrefixesBytes

public com.google.protobuf.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;

Specified by:

getPrefixesBytes in interface SearchRequest.FacetSpec.FacetKeyOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the prefixes at the given index.

getContainsList

public com.google.protobuf.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;

Specified by:

getContainsList in interface SearchRequest.FacetSpec.FacetKeyOrBuilder

Returns:

A list containing the contains.

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;

Specified by:

getContainsCount in interface SearchRequest.FacetSpec.FacetKeyOrBuilder

Returns:

The count of contains.

getContains

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;

Specified by:

getContains in interface SearchRequest.FacetSpec.FacetKeyOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The contains at the given index.

getContainsBytes

public com.google.protobuf.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;

Specified by:

getContainsBytes in interface SearchRequest.FacetSpec.FacetKeyOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the contains at the given index.

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;

Specified by:

getCaseInsensitive in interface SearchRequest.FacetSpec.FacetKeyOrBuilder

Returns:

The caseInsensitive.

getOrderBy

public String getOrderBy()

 The order in which
 [SearchResponse.Facet.values][google.cloud.retail.v2.SearchResponse.Facet.values]
 are returned.

 Allowed values are:

 * "count desc", which means order by
 [SearchResponse.Facet.values.count][google.cloud.retail.v2.SearchResponse.Facet.FacetValue.count]
 descending.

 * "value desc", which means order by
 [SearchResponse.Facet.values.value][google.cloud.retail.v2.SearchResponse.Facet.FacetValue.value]
 descending.
   Only applies to textual facets.

 If not set, textual values are sorted in [natural
 order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical
 intervals are sorted in the order given by
 [FacetSpec.FacetKey.intervals][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.intervals];
 [FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids]
 are sorted in the order given by
 [FacetSpec.FacetKey.restricted_values][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.restricted_values].
 

string order_by = 4;

Specified by:

getOrderBy in interface SearchRequest.FacetSpec.FacetKeyOrBuilder

Returns:

The orderBy.

getOrderByBytes

public com.google.protobuf.ByteString getOrderByBytes()

 The order in which
 [SearchResponse.Facet.values][google.cloud.retail.v2.SearchResponse.Facet.values]
 are returned.

 Allowed values are:

 * "count desc", which means order by
 [SearchResponse.Facet.values.count][google.cloud.retail.v2.SearchResponse.Facet.FacetValue.count]
 descending.

 * "value desc", which means order by
 [SearchResponse.Facet.values.value][google.cloud.retail.v2.SearchResponse.Facet.FacetValue.value]
 descending.
   Only applies to textual facets.

 If not set, textual values are sorted in [natural
 order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical
 intervals are sorted in the order given by
 [FacetSpec.FacetKey.intervals][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.intervals];
 [FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids]
 are sorted in the order given by
 [FacetSpec.FacetKey.restricted_values][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.restricted_values].
 

string order_by = 4;

Specified by:

getOrderByBytes in interface SearchRequest.FacetSpec.FacetKeyOrBuilder

Returns:

The bytes for orderBy.

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][google.cloud.retail.v2.SearchRequest.filter] for
 detail syntax and limitations. Notice that there is no limitation on
 [FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
 when query is specified.

 In the response,
 [SearchResponse.Facet.values.value][google.cloud.retail.v2.SearchResponse.Facet.FacetValue.value]
 will be always "1" and
 [SearchResponse.Facet.values.count][google.cloud.retail.v2.SearchResponse.Facet.FacetValue.count]
 will be the number of results that match the query.

 For example, you can set a customized facet for "shipToStore",
 where
 [FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
 is "customizedShipToStore", and
 [FacetKey.query][google.cloud.retail.v2.SearchRequest.FacetSpec.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;

Specified by:

getQuery in interface SearchRequest.FacetSpec.FacetKeyOrBuilder

Returns:

The query.

getQueryBytes

public com.google.protobuf.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][google.cloud.retail.v2.SearchRequest.filter] for
 detail syntax and limitations. Notice that there is no limitation on
 [FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
 when query is specified.

 In the response,
 [SearchResponse.Facet.values.value][google.cloud.retail.v2.SearchResponse.Facet.FacetValue.value]
 will be always "1" and
 [SearchResponse.Facet.values.count][google.cloud.retail.v2.SearchResponse.Facet.FacetValue.count]
 will be the number of results that match the query.

 For example, you can set a customized facet for "shipToStore",
 where
 [FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
 is "customizedShipToStore", and
 [FacetKey.query][google.cloud.retail.v2.SearchRequest.FacetSpec.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;

Specified by:

getQueryBytes in interface SearchRequest.FacetSpec.FacetKeyOrBuilder

Returns:

The bytes for query.

getReturnMinMax

public boolean getReturnMinMax()

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

bool return_min_max = 11;

Specified by:

getReturnMinMax in interface SearchRequest.FacetSpec.FacetKeyOrBuilder

Returns:

The returnMinMax.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static SearchRequest.FacetSpec.FacetKey parseFrom(ByteBuffer data)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.FacetSpec.FacetKey parseFrom(ByteBuffer data,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.FacetSpec.FacetKey parseFrom(com.google.protobuf.ByteString data)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.FacetSpec.FacetKey parseFrom(com.google.protobuf.ByteString data,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.FacetSpec.FacetKey parseFrom(byte[] data)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.FacetSpec.FacetKey parseFrom(byte[] data,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

IOException

parseFrom

public static SearchRequest.FacetSpec.FacetKey parseFrom(InputStream input,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseDelimitedFrom

public static SearchRequest.FacetSpec.FacetKey parseDelimitedFrom(InputStream input,
                                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                           throws IOException

Throws:

IOException

parseFrom

public static SearchRequest.FacetSpec.FacetKey parseFrom(com.google.protobuf.CodedInputStream input)
                                                  throws IOException

Throws:

IOException

parseFrom

public static SearchRequest.FacetSpec.FacetKey parseFrom(com.google.protobuf.CodedInputStream input,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws IOException

Throws:

IOException

newBuilderForType

public SearchRequest.FacetSpec.FacetKey.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

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

newBuilder

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

toBuilder

public SearchRequest.FacetSpec.FacetKey.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static SearchRequest.FacetSpec.FacetKey getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<SearchRequest.FacetSpec.FacetKey> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public SearchRequest.FacetSpec.FacetKey getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder