public static final class SearchRequest.FacetSpec.FacetKey.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.FacetKey.Builder> implements SearchRequest.FacetSpec.FacetKeyOrBuilder
Specifies how a facet is computed.Protobuf type
google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey| Modifier and Type | Method and Description |
|---|---|
SearchRequest.FacetSpec.FacetKey.Builder |
addAllContains(Iterable<String> values)
Only get facet values that contains the given strings.
|
SearchRequest.FacetSpec.FacetKey.Builder |
addAllIntervals(Iterable<? extends Interval> values)
Set only if values should be bucketized into intervals.
|
SearchRequest.FacetSpec.FacetKey.Builder |
addAllPrefixes(Iterable<String> values)
Only get facet values that start with the given string prefix.
|
SearchRequest.FacetSpec.FacetKey.Builder |
addAllRestrictedValues(Iterable<String> values)
Only get facet for the given restricted values.
|
SearchRequest.FacetSpec.FacetKey.Builder |
addContains(String value)
Only get facet values that contains the given strings.
|
SearchRequest.FacetSpec.FacetKey.Builder |
addContainsBytes(com.google.protobuf.ByteString value)
Only get facet values that contains the given strings.
|
SearchRequest.FacetSpec.FacetKey.Builder |
addIntervals(Interval.Builder builderForValue)
Set only if values should be bucketized into intervals.
|
SearchRequest.FacetSpec.FacetKey.Builder |
addIntervals(Interval value)
Set only if values should be bucketized into intervals.
|
SearchRequest.FacetSpec.FacetKey.Builder |
addIntervals(int index,
Interval.Builder builderForValue)
Set only if values should be bucketized into intervals.
|
SearchRequest.FacetSpec.FacetKey.Builder |
addIntervals(int index,
Interval value)
Set only if values should be bucketized into intervals.
|
Interval.Builder |
addIntervalsBuilder()
Set only if values should be bucketized into intervals.
|
Interval.Builder |
addIntervalsBuilder(int index)
Set only if values should be bucketized into intervals.
|
SearchRequest.FacetSpec.FacetKey.Builder |
addPrefixes(String value)
Only get facet values that start with the given string prefix.
|
SearchRequest.FacetSpec.FacetKey.Builder |
addPrefixesBytes(com.google.protobuf.ByteString value)
Only get facet values that start with the given string prefix.
|
SearchRequest.FacetSpec.FacetKey.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
SearchRequest.FacetSpec.FacetKey.Builder |
addRestrictedValues(String value)
Only get facet for the given restricted values.
|
SearchRequest.FacetSpec.FacetKey.Builder |
addRestrictedValuesBytes(com.google.protobuf.ByteString value)
Only get facet for the given restricted values.
|
SearchRequest.FacetSpec.FacetKey |
build() |
SearchRequest.FacetSpec.FacetKey |
buildPartial() |
SearchRequest.FacetSpec.FacetKey.Builder |
clear() |
SearchRequest.FacetSpec.FacetKey.Builder |
clearCaseInsensitive()
True to make facet keys case insensitive when getting faceting
values with prefixes or contains; false otherwise.
|
SearchRequest.FacetSpec.FacetKey.Builder |
clearContains()
Only get facet values that contains the given strings.
|
SearchRequest.FacetSpec.FacetKey.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
SearchRequest.FacetSpec.FacetKey.Builder |
clearIntervals()
Set only if values should be bucketized into intervals.
|
SearchRequest.FacetSpec.FacetKey.Builder |
clearKey()
Required.
|
SearchRequest.FacetSpec.FacetKey.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
SearchRequest.FacetSpec.FacetKey.Builder |
clearOrderBy()
The order in which
[SearchResponse.Facet.values][google.cloud.retail.v2.SearchResponse.Facet.values]
are returned.
|
SearchRequest.FacetSpec.FacetKey.Builder |
clearPrefixes()
Only get facet values that start with the given string prefix.
|
SearchRequest.FacetSpec.FacetKey.Builder |
clearQuery()
The query that is used to compute facet for the given facet key.
|
SearchRequest.FacetSpec.FacetKey.Builder |
clearRestrictedValues()
Only get facet for the given restricted values.
|
SearchRequest.FacetSpec.FacetKey.Builder |
clearReturnMinMax()
Returns the min and max value for each numerical facet intervals.
|
SearchRequest.FacetSpec.FacetKey.Builder |
clone() |
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.
|
SearchRequest.FacetSpec.FacetKey |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
Interval |
getIntervals(int index)
Set only if values should be bucketized into intervals.
|
Interval.Builder |
getIntervalsBuilder(int index)
Set only if values should be bucketized into intervals.
|
List<Interval.Builder> |
getIntervalsBuilderList()
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.
|
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.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
SearchRequest.FacetSpec.FacetKey.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
SearchRequest.FacetSpec.FacetKey.Builder |
mergeFrom(com.google.protobuf.Message other) |
SearchRequest.FacetSpec.FacetKey.Builder |
mergeFrom(SearchRequest.FacetSpec.FacetKey other) |
SearchRequest.FacetSpec.FacetKey.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
SearchRequest.FacetSpec.FacetKey.Builder |
removeIntervals(int index)
Set only if values should be bucketized into intervals.
|
SearchRequest.FacetSpec.FacetKey.Builder |
setCaseInsensitive(boolean value)
True to make facet keys case insensitive when getting faceting
values with prefixes or contains; false otherwise.
|
SearchRequest.FacetSpec.FacetKey.Builder |
setContains(int index,
String value)
Only get facet values that contains the given strings.
|
SearchRequest.FacetSpec.FacetKey.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
SearchRequest.FacetSpec.FacetKey.Builder |
setIntervals(int index,
Interval.Builder builderForValue)
Set only if values should be bucketized into intervals.
|
SearchRequest.FacetSpec.FacetKey.Builder |
setIntervals(int index,
Interval value)
Set only if values should be bucketized into intervals.
|
SearchRequest.FacetSpec.FacetKey.Builder |
setKey(String value)
Required.
|
SearchRequest.FacetSpec.FacetKey.Builder |
setKeyBytes(com.google.protobuf.ByteString value)
Required.
|
SearchRequest.FacetSpec.FacetKey.Builder |
setOrderBy(String value)
The order in which
[SearchResponse.Facet.values][google.cloud.retail.v2.SearchResponse.Facet.values]
are returned.
|
SearchRequest.FacetSpec.FacetKey.Builder |
setOrderByBytes(com.google.protobuf.ByteString value)
The order in which
[SearchResponse.Facet.values][google.cloud.retail.v2.SearchResponse.Facet.values]
are returned.
|
SearchRequest.FacetSpec.FacetKey.Builder |
setPrefixes(int index,
String value)
Only get facet values that start with the given string prefix.
|
SearchRequest.FacetSpec.FacetKey.Builder |
setQuery(String value)
The query that is used to compute facet for the given facet key.
|
SearchRequest.FacetSpec.FacetKey.Builder |
setQueryBytes(com.google.protobuf.ByteString value)
The query that is used to compute facet for the given facet key.
|
SearchRequest.FacetSpec.FacetKey.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
SearchRequest.FacetSpec.FacetKey.Builder |
setRestrictedValues(int index,
String value)
Only get facet for the given restricted values.
|
SearchRequest.FacetSpec.FacetKey.Builder |
setReturnMinMax(boolean value)
Returns the min and max value for each numerical facet intervals.
|
SearchRequest.FacetSpec.FacetKey.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.FacetKey.Builder>public SearchRequest.FacetSpec.FacetKey.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.FacetKey.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.FacetKey.Builder>public SearchRequest.FacetSpec.FacetKey getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic SearchRequest.FacetSpec.FacetKey build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic SearchRequest.FacetSpec.FacetKey buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic SearchRequest.FacetSpec.FacetKey.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.FacetKey.Builder>public SearchRequest.FacetSpec.FacetKey.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.FacetKey.Builder>public SearchRequest.FacetSpec.FacetKey.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.FacetKey.Builder>public SearchRequest.FacetSpec.FacetKey.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.FacetKey.Builder>public SearchRequest.FacetSpec.FacetKey.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.FacetKey.Builder>public SearchRequest.FacetSpec.FacetKey.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.FacetKey.Builder>public SearchRequest.FacetSpec.FacetKey.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchRequest.FacetSpec.FacetKey.Builder>public SearchRequest.FacetSpec.FacetKey.Builder mergeFrom(SearchRequest.FacetSpec.FacetKey other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.FacetKey.Builder>public SearchRequest.FacetSpec.FacetKey.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchRequest.FacetSpec.FacetKey.Builder>IOExceptionpublic 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];getKey in interface SearchRequest.FacetSpec.FacetKeyOrBuilderpublic 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];getKeyBytes in interface SearchRequest.FacetSpec.FacetKeyOrBuilderpublic SearchRequest.FacetSpec.FacetKey.Builder setKey(String value)
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];value - The key to set.public SearchRequest.FacetSpec.FacetKey.Builder clearKey()
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];public SearchRequest.FacetSpec.FacetKey.Builder setKeyBytes(com.google.protobuf.ByteString value)
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];value - The bytes for key to set.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;getIntervalsList in interface SearchRequest.FacetSpec.FacetKeyOrBuilderpublic 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;getIntervalsCount in interface SearchRequest.FacetSpec.FacetKeyOrBuilderpublic 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;getIntervals in interface SearchRequest.FacetSpec.FacetKeyOrBuilderpublic SearchRequest.FacetSpec.FacetKey.Builder setIntervals(int index, Interval value)
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;public SearchRequest.FacetSpec.FacetKey.Builder setIntervals(int index, Interval.Builder builderForValue)
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;public SearchRequest.FacetSpec.FacetKey.Builder addIntervals(Interval value)
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;public SearchRequest.FacetSpec.FacetKey.Builder addIntervals(int index, Interval value)
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;public SearchRequest.FacetSpec.FacetKey.Builder addIntervals(Interval.Builder builderForValue)
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;public SearchRequest.FacetSpec.FacetKey.Builder addIntervals(int index, Interval.Builder builderForValue)
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;public SearchRequest.FacetSpec.FacetKey.Builder addAllIntervals(Iterable<? extends Interval> values)
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;public SearchRequest.FacetSpec.FacetKey.Builder clearIntervals()
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;public SearchRequest.FacetSpec.FacetKey.Builder removeIntervals(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;public Interval.Builder getIntervalsBuilder(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;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;getIntervalsOrBuilder in interface SearchRequest.FacetSpec.FacetKeyOrBuilderpublic 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;getIntervalsOrBuilderList in interface SearchRequest.FacetSpec.FacetKeyOrBuilderpublic Interval.Builder addIntervalsBuilder()
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;public Interval.Builder addIntervalsBuilder(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;public List<Interval.Builder> getIntervalsBuilderList()
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;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;getRestrictedValuesList in interface SearchRequest.FacetSpec.FacetKeyOrBuilderpublic 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;getRestrictedValuesCount in interface SearchRequest.FacetSpec.FacetKeyOrBuilderpublic 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;getRestrictedValues in interface SearchRequest.FacetSpec.FacetKeyOrBuilderindex - The index of the element to return.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;getRestrictedValuesBytes in interface SearchRequest.FacetSpec.FacetKeyOrBuilderindex - The index of the value to return.public SearchRequest.FacetSpec.FacetKey.Builder setRestrictedValues(int index, String value)
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;index - The index to set the value at.value - The restrictedValues to set.public SearchRequest.FacetSpec.FacetKey.Builder addRestrictedValues(String value)
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;value - The restrictedValues to add.public SearchRequest.FacetSpec.FacetKey.Builder addAllRestrictedValues(Iterable<String> values)
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;values - The restrictedValues to add.public SearchRequest.FacetSpec.FacetKey.Builder clearRestrictedValues()
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;public SearchRequest.FacetSpec.FacetKey.Builder addRestrictedValuesBytes(com.google.protobuf.ByteString value)
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;value - The bytes of the restrictedValues to add.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;getPrefixesList in interface SearchRequest.FacetSpec.FacetKeyOrBuilderpublic 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;getPrefixesCount in interface SearchRequest.FacetSpec.FacetKeyOrBuilderpublic 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;getPrefixes in interface SearchRequest.FacetSpec.FacetKeyOrBuilderindex - The index of the element to return.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;getPrefixesBytes in interface SearchRequest.FacetSpec.FacetKeyOrBuilderindex - The index of the value to return.public SearchRequest.FacetSpec.FacetKey.Builder setPrefixes(int index, String value)
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;index - The index to set the value at.value - The prefixes to set.public SearchRequest.FacetSpec.FacetKey.Builder addPrefixes(String value)
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;value - The prefixes to add.public SearchRequest.FacetSpec.FacetKey.Builder addAllPrefixes(Iterable<String> values)
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;values - The prefixes to add.public SearchRequest.FacetSpec.FacetKey.Builder clearPrefixes()
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;public SearchRequest.FacetSpec.FacetKey.Builder addPrefixesBytes(com.google.protobuf.ByteString value)
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;value - The bytes of the prefixes to add.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;getContainsList in interface SearchRequest.FacetSpec.FacetKeyOrBuilderpublic 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;getContainsCount in interface SearchRequest.FacetSpec.FacetKeyOrBuilderpublic 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;getContains in interface SearchRequest.FacetSpec.FacetKeyOrBuilderindex - The index of the element to return.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;getContainsBytes in interface SearchRequest.FacetSpec.FacetKeyOrBuilderindex - The index of the value to return.public SearchRequest.FacetSpec.FacetKey.Builder setContains(int index, String value)
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;index - The index to set the value at.value - The contains to set.public SearchRequest.FacetSpec.FacetKey.Builder addContains(String value)
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;value - The contains to add.public SearchRequest.FacetSpec.FacetKey.Builder addAllContains(Iterable<String> values)
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;values - The contains to add.public SearchRequest.FacetSpec.FacetKey.Builder clearContains()
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;public SearchRequest.FacetSpec.FacetKey.Builder addContainsBytes(com.google.protobuf.ByteString value)
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;value - The bytes of the contains to add.public boolean getCaseInsensitive()
True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
bool case_insensitive = 10;getCaseInsensitive in interface SearchRequest.FacetSpec.FacetKeyOrBuilderpublic SearchRequest.FacetSpec.FacetKey.Builder setCaseInsensitive(boolean value)
True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
bool case_insensitive = 10;value - The caseInsensitive to set.public SearchRequest.FacetSpec.FacetKey.Builder clearCaseInsensitive()
True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
bool case_insensitive = 10;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;getOrderBy in interface SearchRequest.FacetSpec.FacetKeyOrBuilderpublic 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;getOrderByBytes in interface SearchRequest.FacetSpec.FacetKeyOrBuilderpublic SearchRequest.FacetSpec.FacetKey.Builder setOrderBy(String value)
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;value - The orderBy to set.public SearchRequest.FacetSpec.FacetKey.Builder clearOrderBy()
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;public SearchRequest.FacetSpec.FacetKey.Builder setOrderByBytes(com.google.protobuf.ByteString value)
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;value - The bytes for orderBy to set.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;getQuery in interface SearchRequest.FacetSpec.FacetKeyOrBuilderpublic 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;getQueryBytes in interface SearchRequest.FacetSpec.FacetKeyOrBuilderpublic SearchRequest.FacetSpec.FacetKey.Builder setQuery(String value)
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;value - The query to set.public SearchRequest.FacetSpec.FacetKey.Builder clearQuery()
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;public SearchRequest.FacetSpec.FacetKey.Builder setQueryBytes(com.google.protobuf.ByteString value)
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;value - The bytes for query to set.public boolean getReturnMinMax()
Returns the min and max value for each numerical facet intervals. Ignored for textual facets.
bool return_min_max = 11;getReturnMinMax in interface SearchRequest.FacetSpec.FacetKeyOrBuilderpublic SearchRequest.FacetSpec.FacetKey.Builder setReturnMinMax(boolean value)
Returns the min and max value for each numerical facet intervals. Ignored for textual facets.
bool return_min_max = 11;value - The returnMinMax to set.public SearchRequest.FacetSpec.FacetKey.Builder clearReturnMinMax()
Returns the min and max value for each numerical facet intervals. Ignored for textual facets.
bool return_min_max = 11;public final SearchRequest.FacetSpec.FacetKey.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.FacetKey.Builder>public final SearchRequest.FacetSpec.FacetKey.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.FacetKey.Builder>Copyright © 2024 Google LLC. All rights reserved.