com.google.cloud.retail.v2

Class SearchRequest.FacetSpec

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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

All Implemented Interfaces:

SearchRequest.FacetSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

SearchRequest

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

 A facet specification to perform faceted search.
 

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchRequest.FacetSpec.Builder A facet specification to perform faceted search.
static class	SearchRequest.FacetSpec.FacetKey Specifies how a facet is computed.
static interface	SearchRequest.FacetSpec.FacetKeyOrBuilder

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

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

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

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ENABLE_DYNAMIC_POSITION_FIELD_NUMBER
static int	EXCLUDED_FILTER_KEYS_FIELD_NUMBER
static int	FACET_KEY_FIELD_NUMBER
static int	LIMIT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static SearchRequest.FacetSpec	getDefaultInstance()
SearchRequest.FacetSpec	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getEnableDynamicPosition() Enables dynamic position for this facet.
String	getExcludedFilterKeys(int index) List of keys to exclude when faceting.
com.google.protobuf.ByteString	getExcludedFilterKeysBytes(int index) List of keys to exclude when faceting.
int	getExcludedFilterKeysCount() List of keys to exclude when faceting.
com.google.protobuf.ProtocolStringList	getExcludedFilterKeysList() List of keys to exclude when faceting.
SearchRequest.FacetSpec.FacetKey	getFacetKey() Required.
SearchRequest.FacetSpec.FacetKeyOrBuilder	getFacetKeyOrBuilder() Required.
int	getLimit() Maximum of facet values that should be returned for this facet.
com.google.protobuf.Parser<SearchRequest.FacetSpec>	getParserForType()
int	getSerializedSize()
boolean	hasFacetKey() Required.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static SearchRequest.FacetSpec.Builder	newBuilder()
static SearchRequest.FacetSpec.Builder	newBuilder(SearchRequest.FacetSpec prototype)
SearchRequest.FacetSpec.Builder	newBuilderForType()
protected SearchRequest.FacetSpec.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static SearchRequest.FacetSpec	parseDelimitedFrom(InputStream input)
static SearchRequest.FacetSpec	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.FacetSpec	parseFrom(byte[] data)
static SearchRequest.FacetSpec	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.FacetSpec	parseFrom(ByteBuffer data)
static SearchRequest.FacetSpec	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.FacetSpec	parseFrom(com.google.protobuf.ByteString data)
static SearchRequest.FacetSpec	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.FacetSpec	parseFrom(com.google.protobuf.CodedInputStream input)
static SearchRequest.FacetSpec	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.FacetSpec	parseFrom(InputStream input)
static SearchRequest.FacetSpec	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SearchRequest.FacetSpec>	parser()
SearchRequest.FacetSpec.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

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

Methods inherited from class com.google.protobuf.AbstractMessage

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

Methods inherited from class com.google.protobuf.AbstractMessageLite

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

FACET_KEY_FIELD_NUMBER

public static final int FACET_KEY_FIELD_NUMBER

See Also:

Constant Field Values

LIMIT_FIELD_NUMBER

public static final int LIMIT_FIELD_NUMBER

See Also:

Constant Field Values

EXCLUDED_FILTER_KEYS_FIELD_NUMBER

public static final int EXCLUDED_FILTER_KEYS_FIELD_NUMBER

See Also:

Constant Field Values

ENABLE_DYNAMIC_POSITION_FIELD_NUMBER

public static final int ENABLE_DYNAMIC_POSITION_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

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

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasFacetKey

public boolean hasFacetKey()

 Required. The facet key specification.
 

.google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey facet_key = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

hasFacetKey in interface SearchRequest.FacetSpecOrBuilder

Returns:

Whether the facetKey field is set.

getFacetKey

public SearchRequest.FacetSpec.FacetKey getFacetKey()

 Required. The facet key specification.
 

.google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey facet_key = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getFacetKey in interface SearchRequest.FacetSpecOrBuilder

Returns:

The facetKey.

getFacetKeyOrBuilder

public SearchRequest.FacetSpec.FacetKeyOrBuilder getFacetKeyOrBuilder()

 Required. The facet key specification.
 

.google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey facet_key = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getFacetKeyOrBuilder in interface SearchRequest.FacetSpecOrBuilder

getLimit

public int getLimit()

 Maximum of facet values that should be returned for this facet. If
 unspecified, defaults to 50. The maximum allowed value is 300. Values
 above 300 will be coerced to 300.

 If this field is negative, an INVALID_ARGUMENT is returned.
 

int32 limit = 2;

Specified by:

getLimit in interface SearchRequest.FacetSpecOrBuilder

Returns:

The limit.

getExcludedFilterKeysList

public com.google.protobuf.ProtocolStringList getExcludedFilterKeysList()

 List of keys to exclude when faceting.


 By default,
 [FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
 is not excluded from the filter unless it is listed in this field.

 Listing a facet key in this field allows its values to appear as facet
 results, even when they are filtered out of search results. Using this
 field does not affect what search results are returned.

 For example, suppose there are 100 products with the color facet "Red"
 and 200 products with the color facet "Blue". A query containing the
 filter "colorFamilies:ANY("Red")" and having "colorFamilies" as
 [FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
 would by default return only "Red" products in the search results, and
 also return "Red" with count 100 as the only color facet. Although there
 are also blue products available, "Blue" would not be shown as an
 available facet value.

 If "colorFamilies" is listed in "excludedFilterKeys", then the query
 returns the facet values "Red" with count 100 and "Blue" with count
 200, because the "colorFamilies" key is now excluded from the filter.
 Because this field doesn't affect search results, the search results
 are still correctly filtered to return only "Red" products.

 A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error
 is returned.
 

repeated string excluded_filter_keys = 3;

Specified by:

getExcludedFilterKeysList in interface SearchRequest.FacetSpecOrBuilder

Returns:

A list containing the excludedFilterKeys.

getExcludedFilterKeysCount

public int getExcludedFilterKeysCount()

 List of keys to exclude when faceting.


 By default,
 [FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
 is not excluded from the filter unless it is listed in this field.

 Listing a facet key in this field allows its values to appear as facet
 results, even when they are filtered out of search results. Using this
 field does not affect what search results are returned.

 For example, suppose there are 100 products with the color facet "Red"
 and 200 products with the color facet "Blue". A query containing the
 filter "colorFamilies:ANY("Red")" and having "colorFamilies" as
 [FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
 would by default return only "Red" products in the search results, and
 also return "Red" with count 100 as the only color facet. Although there
 are also blue products available, "Blue" would not be shown as an
 available facet value.

 If "colorFamilies" is listed in "excludedFilterKeys", then the query
 returns the facet values "Red" with count 100 and "Blue" with count
 200, because the "colorFamilies" key is now excluded from the filter.
 Because this field doesn't affect search results, the search results
 are still correctly filtered to return only "Red" products.

 A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error
 is returned.
 

repeated string excluded_filter_keys = 3;

Specified by:

getExcludedFilterKeysCount in interface SearchRequest.FacetSpecOrBuilder

Returns:

The count of excludedFilterKeys.

getExcludedFilterKeys

public String getExcludedFilterKeys(int index)

 List of keys to exclude when faceting.


 By default,
 [FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
 is not excluded from the filter unless it is listed in this field.

 Listing a facet key in this field allows its values to appear as facet
 results, even when they are filtered out of search results. Using this
 field does not affect what search results are returned.

 For example, suppose there are 100 products with the color facet "Red"
 and 200 products with the color facet "Blue". A query containing the
 filter "colorFamilies:ANY("Red")" and having "colorFamilies" as
 [FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
 would by default return only "Red" products in the search results, and
 also return "Red" with count 100 as the only color facet. Although there
 are also blue products available, "Blue" would not be shown as an
 available facet value.

 If "colorFamilies" is listed in "excludedFilterKeys", then the query
 returns the facet values "Red" with count 100 and "Blue" with count
 200, because the "colorFamilies" key is now excluded from the filter.
 Because this field doesn't affect search results, the search results
 are still correctly filtered to return only "Red" products.

 A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error
 is returned.
 

repeated string excluded_filter_keys = 3;

Specified by:

getExcludedFilterKeys in interface SearchRequest.FacetSpecOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The excludedFilterKeys at the given index.

getExcludedFilterKeysBytes

public com.google.protobuf.ByteString getExcludedFilterKeysBytes(int index)

 List of keys to exclude when faceting.


 By default,
 [FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
 is not excluded from the filter unless it is listed in this field.

 Listing a facet key in this field allows its values to appear as facet
 results, even when they are filtered out of search results. Using this
 field does not affect what search results are returned.

 For example, suppose there are 100 products with the color facet "Red"
 and 200 products with the color facet "Blue". A query containing the
 filter "colorFamilies:ANY("Red")" and having "colorFamilies" as
 [FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
 would by default return only "Red" products in the search results, and
 also return "Red" with count 100 as the only color facet. Although there
 are also blue products available, "Blue" would not be shown as an
 available facet value.

 If "colorFamilies" is listed in "excludedFilterKeys", then the query
 returns the facet values "Red" with count 100 and "Blue" with count
 200, because the "colorFamilies" key is now excluded from the filter.
 Because this field doesn't affect search results, the search results
 are still correctly filtered to return only "Red" products.

 A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error
 is returned.
 

repeated string excluded_filter_keys = 3;

Specified by:

getExcludedFilterKeysBytes in interface SearchRequest.FacetSpecOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the excludedFilterKeys at the given index.

getEnableDynamicPosition

public boolean getEnableDynamicPosition()

 Enables dynamic position for this facet. If set to true, the position of
 this facet among all facets in the response is determined by Google
 Retail Search. It will be ordered together with dynamic facets if dynamic
 facets is enabled. If set to false, the position of this facet in the
 response will be the same as in the request, and it will be ranked before
 the facets with dynamic position enable and all dynamic facets.

 For example, you may always want to have rating facet returned in
 the response, but it's not necessarily to always display the rating facet
 at the top. In that case, you can set enable_dynamic_position to true so
 that the position of rating facet in response will be determined by
 Google Retail Search.

 Another example, assuming you have the following facets in the request:

 * "rating", enable_dynamic_position = true

 * "price", enable_dynamic_position = false

 * "brands", enable_dynamic_position = false

 And also you have a dynamic facets enable, which will generate a facet
 'gender'. Then the final order of the facets in the response can be
 ("price", "brands", "rating", "gender") or ("price", "brands", "gender",
 "rating") depends on how Google Retail Search orders "gender" and
 "rating" facets. However, notice that "price" and "brands" will always be
 ranked at 1st and 2nd position since their enable_dynamic_position are
 false.
 

bool enable_dynamic_position = 4;

Specified by:

getEnableDynamicPosition in interface SearchRequest.FacetSpecOrBuilder

Returns:

The enableDynamicPosition.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

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

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public SearchRequest.FacetSpec.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static SearchRequest.FacetSpec.Builder newBuilder()

newBuilder

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

toBuilder

public SearchRequest.FacetSpec.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static SearchRequest.FacetSpec getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public SearchRequest.FacetSpec getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder