Class SearchRequest.FacetSpec.FacetKey.Builder (2.30.0)

public static final class SearchRequest.FacetSpec.FacetKey.Builder extends 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

Inheritance

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

Implements

SearchRequest.FacetSpec.FacetKeyOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addAllContains(Iterable<String> values)

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;

Parameter
Name	Description
`values`	`Iterable<String>` The contains to add.

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`	This builder for chaining.

addAllIntervals(Iterable<? extends Interval> values)

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;

Parameter
Name	Description
`values`	`Iterable<? extends com.google.cloud.retail.v2.Interval>`

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`

addAllPrefixes(Iterable<String> values)

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;

Parameter
Name	Description
`values`	`Iterable<String>` The prefixes to add.

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`	This builder for chaining.

addAllRestrictedValues(Iterable<String> values)

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;

Parameter
Name	Description
`values`	`Iterable<String>` The restrictedValues to add.

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`	This builder for chaining.

addContains(String value)

public SearchRequest.FacetSpec.FacetKey.Builder addContains(String value)

repeated string contains = 9;

Parameter
Name	Description
`value`	`String` The contains to add.

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`	This builder for chaining.

addContainsBytes(ByteString value)

public SearchRequest.FacetSpec.FacetKey.Builder addContainsBytes(ByteString value)

repeated string contains = 9;

Parameter
Name	Description
`value`	`ByteString` The bytes of the contains to add.

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`	This builder for chaining.

addIntervals(Interval value)

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.

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

Parameter
Name	Description
`value`	`Interval`

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`

addIntervals(Interval.Builder builderForValue)

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.

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

Parameter
Name	Description
`builderForValue`	`Interval.Builder`

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`

addIntervals(int index, Interval value)

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.

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

Parameters
Name	Description
`index`	`int`
`value`	`Interval`

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`

addIntervals(int index, Interval.Builder builderForValue)

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.

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

Parameters
Name	Description
`index`	`int`
`builderForValue`	`Interval.Builder`

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`

addIntervalsBuilder()

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

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

Returns
Type	Description
`Interval.Builder`

addIntervalsBuilder(int index)

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.

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

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Interval.Builder`

addPrefixes(String value)

public SearchRequest.FacetSpec.FacetKey.Builder addPrefixes(String value)

repeated string prefixes = 8;

Parameter
Name	Description
`value`	`String` The prefixes to add.

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`	This builder for chaining.

addPrefixesBytes(ByteString value)

public SearchRequest.FacetSpec.FacetKey.Builder addPrefixesBytes(ByteString value)

repeated string prefixes = 8;

Parameter
Name	Description
`value`	`ByteString` The bytes of the prefixes to add.

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchRequest.FacetSpec.FacetKey.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addRestrictedValues(String value)

public SearchRequest.FacetSpec.FacetKey.Builder addRestrictedValues(String value)

Must be set for the fulfillment facet keys:

pickupInStore
shipToStore
sameDayDelivery
nextDayDelivery
customFulfillment1
customFulfillment2
customFulfillment3
customFulfillment4
customFulfillment5

repeated string restricted_values = 3;

Parameter
Name	Description
`value`	`String` The restrictedValues to add.

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`	This builder for chaining.

addRestrictedValuesBytes(ByteString value)

public SearchRequest.FacetSpec.FacetKey.Builder addRestrictedValuesBytes(ByteString value)

Must be set for the fulfillment facet keys:

pickupInStore
shipToStore
sameDayDelivery
nextDayDelivery
customFulfillment1
customFulfillment2
customFulfillment3
customFulfillment4
customFulfillment5

repeated string restricted_values = 3;

Parameter
Name	Description
`value`	`ByteString` The bytes of the restrictedValues to add.

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`	This builder for chaining.

build()

public SearchRequest.FacetSpec.FacetKey build()

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey`

buildPartial()

public SearchRequest.FacetSpec.FacetKey buildPartial()

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey`

clear()

public SearchRequest.FacetSpec.FacetKey.Builder clear()

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearCaseInsensitive()

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;

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`	This builder for chaining.

clearContains()

public SearchRequest.FacetSpec.FacetKey.Builder clearContains()

repeated string contains = 9;

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public SearchRequest.FacetSpec.FacetKey.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearIntervals()

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.

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

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`

clearKey()

public SearchRequest.FacetSpec.FacetKey.Builder clearKey()

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

Allowed facet keys when FacetKey.query is not specified:

textual_field =
- "brands"
- "categories"
- "genders"
- "ageGroups"
- "availability"
- "colorFamilies"
- "colors"
- "sizes"
- "materials"
- "patterns"
- "conditions"
- "attributes.key"
- "pickupInStore"
- "shipToStore"
- "sameDayDelivery"
- "nextDayDelivery"
- "customFulfillment1"
- "customFulfillment2"
- "customFulfillment3"
- "customFulfillment4"
- "customFulfillment5"
- "inventory(place_id,attributes.key)"
numerical_field =
- "price"
- "discount"
- "rating"
- "ratingCount"
- "attributes.key"
- "inventory(place_id,price)"
- "inventory(place_id,original_price)"
- "inventory(place_id,attributes.key)"

string key = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchRequest.FacetSpec.FacetKey.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearOrderBy()

public SearchRequest.FacetSpec.FacetKey.Builder clearOrderBy()

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

Allowed values are:

"count desc", which means order by SearchResponse.Facet.values.count descending.
"value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets.

If not set, textual values are sorted in natural order; numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals; FulfillmentInfo.place_ids are sorted in the order given by FacetSpec.FacetKey.restricted_values.

string order_by = 4;

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`	This builder for chaining.

clearPrefixes()

public SearchRequest.FacetSpec.FacetKey.Builder clearPrefixes()

repeated string prefixes = 8;

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`	This builder for chaining.

clearQuery()

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 for detail syntax and limitations. Notice that there is no limitation on FacetKey.key when query is specified.

In the response, SearchResponse.Facet.values.value will be always "1" and SearchResponse.Facet.values.count will be the number of results that match the query.

For example, you can set a customized facet for "shipToStore", where FacetKey.key is "customizedShipToStore", and FacetKey.query is "availability: ANY(\"IN_STOCK\") AND shipToStore: ANY(\"123\")". Then the facet will count the products that are both in stock and ship to store "123".

string query = 5;

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`	This builder for chaining.

clearRestrictedValues()

public SearchRequest.FacetSpec.FacetKey.Builder clearRestrictedValues()

Must be set for the fulfillment facet keys:

pickupInStore
shipToStore
sameDayDelivery
nextDayDelivery
customFulfillment1
customFulfillment2
customFulfillment3
customFulfillment4
customFulfillment5

repeated string restricted_values = 3;

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`	This builder for chaining.

clearReturnMinMax()

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;

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`	This builder for chaining.

clone()

public SearchRequest.FacetSpec.FacetKey.Builder clone()

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getCaseInsensitive()

public boolean getCaseInsensitive()

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

bool case_insensitive = 10;

Returns
Type	Description
`boolean`	The caseInsensitive.

getContains(int index)

public String getContains(int index)

repeated string contains = 9;

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

Returns
Type	Description
`String`	The contains at the given index.

getContainsBytes(int index)

public ByteString getContainsBytes(int index)

repeated string contains = 9;

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

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

getContainsCount()

public int getContainsCount()

repeated string contains = 9;

Returns
Type	Description
`int`	The count of contains.

getContainsList()

public ProtocolStringList getContainsList()

repeated string contains = 9;

Returns
Type	Description
`ProtocolStringList`	A list containing the contains.

getDefaultInstanceForType()

public SearchRequest.FacetSpec.FacetKey getDefaultInstanceForType()

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getIntervals(int index)

public Interval getIntervals(int index)

Set only if values should be bucketized into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 40.

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

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Interval`

getIntervalsBuilder(int index)

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.

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

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Interval.Builder`

getIntervalsBuilderList()

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.

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

Returns
Type	Description
`List<Builder>`

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.

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

Returns
Type	Description
`int`

getIntervalsList()

public List<Interval> getIntervalsList()

Set only if values should be bucketized into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 40.

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

Returns
Type	Description
`List<Interval>`

getIntervalsOrBuilder(int index)

public IntervalOrBuilder getIntervalsOrBuilder(int index)

Set only if values should be bucketized into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 40.

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

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`IntervalOrBuilder`

getIntervalsOrBuilderList()

public List<? extends IntervalOrBuilder> getIntervalsOrBuilderList()

Set only if values should be bucketized into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 40.

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

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

getKey()

public String getKey()

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

Allowed facet keys when FacetKey.query is not specified:

textual_field =
- "brands"
- "categories"
- "genders"
- "ageGroups"
- "availability"
- "colorFamilies"
- "colors"
- "sizes"
- "materials"
- "patterns"
- "conditions"
- "attributes.key"
- "pickupInStore"
- "shipToStore"
- "sameDayDelivery"
- "nextDayDelivery"
- "customFulfillment1"
- "customFulfillment2"
- "customFulfillment3"
- "customFulfillment4"
- "customFulfillment5"
- "inventory(place_id,attributes.key)"
numerical_field =
- "price"
- "discount"
- "rating"
- "ratingCount"
- "attributes.key"
- "inventory(place_id,price)"
- "inventory(place_id,original_price)"
- "inventory(place_id,attributes.key)"

string key = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`String`	The key.

getKeyBytes()

public ByteString getKeyBytes()

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

Allowed facet keys when FacetKey.query is not specified:

textual_field =
- "brands"
- "categories"
- "genders"
- "ageGroups"
- "availability"
- "colorFamilies"
- "colors"
- "sizes"
- "materials"
- "patterns"
- "conditions"
- "attributes.key"
- "pickupInStore"
- "shipToStore"
- "sameDayDelivery"
- "nextDayDelivery"
- "customFulfillment1"
- "customFulfillment2"
- "customFulfillment3"
- "customFulfillment4"
- "customFulfillment5"
- "inventory(place_id,attributes.key)"
numerical_field =
- "price"
- "discount"
- "rating"
- "ratingCount"
- "attributes.key"
- "inventory(place_id,price)"
- "inventory(place_id,original_price)"
- "inventory(place_id,attributes.key)"

string key = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`ByteString`	The bytes for key.

getOrderBy()

public String getOrderBy()

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

Allowed values are:

"count desc", which means order by SearchResponse.Facet.values.count descending.
"value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets.

If not set, textual values are sorted in natural order; numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals; FulfillmentInfo.place_ids are sorted in the order given by FacetSpec.FacetKey.restricted_values.

string order_by = 4;

Returns
Type	Description
`String`	The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

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

Allowed values are:

"count desc", which means order by SearchResponse.Facet.values.count descending.
"value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets.

If not set, textual values are sorted in natural order; numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals; FulfillmentInfo.place_ids are sorted in the order given by FacetSpec.FacetKey.restricted_values.

string order_by = 4;

Returns
Type	Description
`ByteString`	The bytes for orderBy.

getPrefixes(int index)

public String getPrefixes(int index)

repeated string prefixes = 8;

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

Returns
Type	Description
`String`	The prefixes at the given index.

getPrefixesBytes(int index)

public ByteString getPrefixesBytes(int index)

repeated string prefixes = 8;

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

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

getPrefixesCount()

public int getPrefixesCount()

repeated string prefixes = 8;

Returns
Type	Description
`int`	The count of prefixes.

getPrefixesList()

public ProtocolStringList getPrefixesList()

repeated string prefixes = 8;

Returns
Type	Description
`ProtocolStringList`	A list containing the prefixes.

getQuery()

public String getQuery()

In the response, SearchResponse.Facet.values.value will be always "1" and SearchResponse.Facet.values.count will be the number of results that match the query.

string query = 5;

Returns
Type	Description
`String`	The query.

getQueryBytes()

public ByteString getQueryBytes()

In the response, SearchResponse.Facet.values.value will be always "1" and SearchResponse.Facet.values.count will be the number of results that match the query.

string query = 5;

Returns
Type	Description
`ByteString`	The bytes for query.

getRestrictedValues(int index)

public String getRestrictedValues(int index)

Must be set for the fulfillment facet keys:

pickupInStore
shipToStore
sameDayDelivery
nextDayDelivery
customFulfillment1
customFulfillment2
customFulfillment3
customFulfillment4
customFulfillment5

repeated string restricted_values = 3;

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

Returns
Type	Description
`String`	The restrictedValues at the given index.

getRestrictedValuesBytes(int index)

public ByteString getRestrictedValuesBytes(int index)

Must be set for the fulfillment facet keys:

pickupInStore
shipToStore
sameDayDelivery
nextDayDelivery
customFulfillment1
customFulfillment2
customFulfillment3
customFulfillment4
customFulfillment5

repeated string restricted_values = 3;

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

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

getRestrictedValuesCount()

public int getRestrictedValuesCount()

Must be set for the fulfillment facet keys:

pickupInStore
shipToStore
sameDayDelivery
nextDayDelivery
customFulfillment1
customFulfillment2
customFulfillment3
customFulfillment4
customFulfillment5

repeated string restricted_values = 3;

Returns
Type	Description
`int`	The count of restrictedValues.

getRestrictedValuesList()

public ProtocolStringList getRestrictedValuesList()

Must be set for the fulfillment facet keys:

pickupInStore
shipToStore
sameDayDelivery
nextDayDelivery
customFulfillment1
customFulfillment2
customFulfillment3
customFulfillment4
customFulfillment5

repeated string restricted_values = 3;

Returns
Type	Description
`ProtocolStringList`	A list containing the restrictedValues.

getReturnMinMax()

public boolean getReturnMinMax()

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

bool return_min_max = 11;

Returns
Type	Description
`boolean`	The returnMinMax.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(SearchRequest.FacetSpec.FacetKey other)

public SearchRequest.FacetSpec.FacetKey.Builder mergeFrom(SearchRequest.FacetSpec.FacetKey other)

Parameter
Name	Description
`other`	`SearchRequest.FacetSpec.FacetKey`

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchRequest.FacetSpec.FacetKey.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public SearchRequest.FacetSpec.FacetKey.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.FacetSpec.FacetKey.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeIntervals(int index)

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.

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

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`

setCaseInsensitive(boolean value)

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

Parameter
Name	Description
`value`	`boolean` The caseInsensitive to set.

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`	This builder for chaining.

setContains(int index, String value)

public SearchRequest.FacetSpec.FacetKey.Builder setContains(int index, String value)

repeated string contains = 9;

Parameters
Name	Description
`index`	`int` The index to set the value at.
`value`	`String` The contains to set.

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public SearchRequest.FacetSpec.FacetKey.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setIntervals(int index, Interval value)

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

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

Parameters
Name	Description
`index`	`int`
`value`	`Interval`

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`

setIntervals(int index, Interval.Builder builderForValue)

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.

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

Parameters
Name	Description
`index`	`int`
`builderForValue`	`Interval.Builder`

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`

setKey(String value)

public SearchRequest.FacetSpec.FacetKey.Builder setKey(String value)

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

Allowed facet keys when FacetKey.query is not specified:

textual_field =
- "brands"
- "categories"
- "genders"
- "ageGroups"
- "availability"
- "colorFamilies"
- "colors"
- "sizes"
- "materials"
- "patterns"
- "conditions"
- "attributes.key"
- "pickupInStore"
- "shipToStore"
- "sameDayDelivery"
- "nextDayDelivery"
- "customFulfillment1"
- "customFulfillment2"
- "customFulfillment3"
- "customFulfillment4"
- "customFulfillment5"
- "inventory(place_id,attributes.key)"
numerical_field =
- "price"
- "discount"
- "rating"
- "ratingCount"
- "attributes.key"
- "inventory(place_id,price)"
- "inventory(place_id,original_price)"
- "inventory(place_id,attributes.key)"

string key = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`value`	`String` The key to set.

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`	This builder for chaining.

setKeyBytes(ByteString value)

public SearchRequest.FacetSpec.FacetKey.Builder setKeyBytes(ByteString value)

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

Allowed facet keys when FacetKey.query is not specified:

textual_field =
- "brands"
- "categories"
- "genders"
- "ageGroups"
- "availability"
- "colorFamilies"
- "colors"
- "sizes"
- "materials"
- "patterns"
- "conditions"
- "attributes.key"
- "pickupInStore"
- "shipToStore"
- "sameDayDelivery"
- "nextDayDelivery"
- "customFulfillment1"
- "customFulfillment2"
- "customFulfillment3"
- "customFulfillment4"
- "customFulfillment5"
- "inventory(place_id,attributes.key)"
numerical_field =
- "price"
- "discount"
- "rating"
- "ratingCount"
- "attributes.key"
- "inventory(place_id,price)"
- "inventory(place_id,original_price)"
- "inventory(place_id,attributes.key)"

string key = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`value`	`ByteString` The bytes for key to set.

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`	This builder for chaining.

setOrderBy(String value)

public SearchRequest.FacetSpec.FacetKey.Builder setOrderBy(String value)

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

Allowed values are:

"count desc", which means order by SearchResponse.Facet.values.count descending.
"value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets.

If not set, textual values are sorted in natural order; numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals; FulfillmentInfo.place_ids are sorted in the order given by FacetSpec.FacetKey.restricted_values.

string order_by = 4;

Parameter
Name	Description
`value`	`String` The orderBy to set.

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`	This builder for chaining.

setOrderByBytes(ByteString value)

public SearchRequest.FacetSpec.FacetKey.Builder setOrderByBytes(ByteString value)

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

Allowed values are:

"count desc", which means order by SearchResponse.Facet.values.count descending.
"value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets.

If not set, textual values are sorted in natural order; numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals; FulfillmentInfo.place_ids are sorted in the order given by FacetSpec.FacetKey.restricted_values.

string order_by = 4;

Parameter
Name	Description
`value`	`ByteString` The bytes for orderBy to set.

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`	This builder for chaining.

setPrefixes(int index, String value)

public SearchRequest.FacetSpec.FacetKey.Builder setPrefixes(int index, String value)

repeated string prefixes = 8;

Parameters
Name	Description
`index`	`int` The index to set the value at.
`value`	`String` The prefixes to set.

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`	This builder for chaining.

setQuery(String value)

public SearchRequest.FacetSpec.FacetKey.Builder setQuery(String value)

In the response, SearchResponse.Facet.values.value will be always "1" and SearchResponse.Facet.values.count will be the number of results that match the query.

string query = 5;

Parameter
Name	Description
`value`	`String` The query to set.

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`	This builder for chaining.

setQueryBytes(ByteString value)

public SearchRequest.FacetSpec.FacetKey.Builder setQueryBytes(ByteString value)

In the response, SearchResponse.Facet.values.value will be always "1" and SearchResponse.Facet.values.count will be the number of results that match the query.

string query = 5;

Parameter
Name	Description
`value`	`ByteString` The bytes for query to set.

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SearchRequest.FacetSpec.FacetKey.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setRestrictedValues(int index, String value)

public SearchRequest.FacetSpec.FacetKey.Builder setRestrictedValues(int index, String value)

Must be set for the fulfillment facet keys:

pickupInStore
shipToStore
sameDayDelivery
nextDayDelivery
customFulfillment1
customFulfillment2
customFulfillment3
customFulfillment4
customFulfillment5

repeated string restricted_values = 3;

Parameters
Name	Description
`index`	`int` The index to set the value at.
`value`	`String` The restrictedValues to set.

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`	This builder for chaining.

setReturnMinMax(boolean value)

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

Parameter
Name	Description
`value`	`boolean` The returnMinMax to set.

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.FacetSpec.FacetKey.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`SearchRequest.FacetSpec.FacetKey.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)