public static final class SearchRequest.FacetSpec.FacetKey extends com.google.protobuf.GeneratedMessageV3 implements SearchRequest.FacetSpec.FacetKeyOrBuilder
Specifies how a facet is computed.Protobuf type
google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec.FacetKey| Modifier and Type | Class and Description |
|---|---|
static class |
SearchRequest.FacetSpec.FacetKey.Builder
Specifies how a facet is computed.
|
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| Modifier and Type | Field and Description |
|---|---|
static int |
CASE_INSENSITIVE_FIELD_NUMBER |
static int |
CONTAINS_FIELD_NUMBER |
static int |
INTERVALS_FIELD_NUMBER |
static int |
KEY_FIELD_NUMBER |
static int |
ORDER_BY_FIELD_NUMBER |
static int |
PREFIXES_FIELD_NUMBER |
static int |
RESTRICTED_VALUES_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
boolean |
getCaseInsensitive()
True to make facet keys case insensitive when getting faceting
values with prefixes or contains; false otherwise.
|
String |
getContains(int index)
Only get facet values that contain the given strings.
|
com.google.protobuf.ByteString |
getContainsBytes(int index)
Only get facet values that contain the given strings.
|
int |
getContainsCount()
Only get facet values that contain the given strings.
|
com.google.protobuf.ProtocolStringList |
getContainsList()
Only get facet values that contain the given strings.
|
static SearchRequest.FacetSpec.FacetKey |
getDefaultInstance() |
SearchRequest.FacetSpec.FacetKey |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
Interval |
getIntervals(int index)
Set only if values should be bucketed into intervals.
|
int |
getIntervalsCount()
Set only if values should be bucketed into intervals.
|
List<Interval> |
getIntervalsList()
Set only if values should be bucketed into intervals.
|
IntervalOrBuilder |
getIntervalsOrBuilder(int index)
Set only if values should be bucketed into intervals.
|
List<? extends IntervalOrBuilder> |
getIntervalsOrBuilderList()
Set only if values should be bucketed into intervals.
|
String |
getKey()
Required.
|
com.google.protobuf.ByteString |
getKeyBytes()
Required.
|
String |
getOrderBy()
The order in which documents are returned.
|
com.google.protobuf.ByteString |
getOrderByBytes()
The order in which documents are returned.
|
com.google.protobuf.Parser<SearchRequest.FacetSpec.FacetKey> |
getParserForType() |
String |
getPrefixes(int index)
Only get facet values that start with the given string prefix.
|
com.google.protobuf.ByteString |
getPrefixesBytes(int index)
Only get facet values that start with the given string prefix.
|
int |
getPrefixesCount()
Only get facet values that start with the given string prefix.
|
com.google.protobuf.ProtocolStringList |
getPrefixesList()
Only get facet values that start with the given string prefix.
|
String |
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.
|
int |
getSerializedSize() |
int |
hashCode() |
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static SearchRequest.FacetSpec.FacetKey.Builder |
newBuilder() |
static SearchRequest.FacetSpec.FacetKey.Builder |
newBuilder(SearchRequest.FacetSpec.FacetKey prototype) |
SearchRequest.FacetSpec.FacetKey.Builder |
newBuilderForType() |
protected SearchRequest.FacetSpec.FacetKey.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static SearchRequest.FacetSpec.FacetKey |
parseDelimitedFrom(InputStream input) |
static SearchRequest.FacetSpec.FacetKey |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static SearchRequest.FacetSpec.FacetKey |
parseFrom(byte[] data) |
static SearchRequest.FacetSpec.FacetKey |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static SearchRequest.FacetSpec.FacetKey |
parseFrom(ByteBuffer data) |
static SearchRequest.FacetSpec.FacetKey |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static SearchRequest.FacetSpec.FacetKey |
parseFrom(com.google.protobuf.ByteString data) |
static SearchRequest.FacetSpec.FacetKey |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static SearchRequest.FacetSpec.FacetKey |
parseFrom(com.google.protobuf.CodedInputStream input) |
static SearchRequest.FacetSpec.FacetKey |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static SearchRequest.FacetSpec.FacetKey |
parseFrom(InputStream input) |
static SearchRequest.FacetSpec.FacetKey |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<SearchRequest.FacetSpec.FacetKey> |
parser() |
SearchRequest.FacetSpec.FacetKey.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
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, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int KEY_FIELD_NUMBER
public static final int INTERVALS_FIELD_NUMBER
public static final int RESTRICTED_VALUES_FIELD_NUMBER
public static final int PREFIXES_FIELD_NUMBER
public static final int CONTAINS_FIELD_NUMBER
public static final int CASE_INSENSITIVE_FIELD_NUMBER
public static final int ORDER_BY_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public String getKey()
Required. Supported textual and numerical facet keys in [Document][google.cloud.discoveryengine.v1beta.Document] object, over which the facet values are computed. Facet key is case-sensitive.
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 [Document][google.cloud.discoveryengine.v1beta.Document] object, over which the facet values are computed. Facet key is case-sensitive.
string key = 1 [(.google.api.field_behavior) = REQUIRED];getKeyBytes in interface SearchRequest.FacetSpec.FacetKeyOrBuilderpublic List<Interval> getIntervalsList()
Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.
repeated .google.cloud.discoveryengine.v1beta.Interval intervals = 2;getIntervalsList in interface SearchRequest.FacetSpec.FacetKeyOrBuilderpublic List<? extends IntervalOrBuilder> getIntervalsOrBuilderList()
Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.
repeated .google.cloud.discoveryengine.v1beta.Interval intervals = 2;getIntervalsOrBuilderList in interface SearchRequest.FacetSpec.FacetKeyOrBuilderpublic int getIntervalsCount()
Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.
repeated .google.cloud.discoveryengine.v1beta.Interval intervals = 2;getIntervalsCount in interface SearchRequest.FacetSpec.FacetKeyOrBuilderpublic Interval getIntervals(int index)
Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.
repeated .google.cloud.discoveryengine.v1beta.Interval intervals = 2;getIntervals in interface SearchRequest.FacetSpec.FacetKeyOrBuilderpublic IntervalOrBuilder getIntervalsOrBuilder(int index)
Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.
repeated .google.cloud.discoveryengine.v1beta.Interval intervals = 2;getIntervalsOrBuilder in interface SearchRequest.FacetSpec.FacetKeyOrBuilderpublic com.google.protobuf.ProtocolStringList getRestrictedValuesList()
Only get facet for the given restricted values. Only supported on textual fields. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "restricted_values" to "Action > 2022", the "category" facet only contains "Action > 2022". Only supported on textual fields. Maximum is 10.
repeated string restricted_values = 3;getRestrictedValuesList in interface SearchRequest.FacetSpec.FacetKeyOrBuilderpublic int getRestrictedValuesCount()
Only get facet for the given restricted values. Only supported on textual fields. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "restricted_values" to "Action > 2022", the "category" facet only contains "Action > 2022". Only supported on textual fields. Maximum is 10.
repeated string restricted_values = 3;getRestrictedValuesCount in interface SearchRequest.FacetSpec.FacetKeyOrBuilderpublic String getRestrictedValues(int index)
Only get facet for the given restricted values. Only supported on textual fields. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "restricted_values" to "Action > 2022", the "category" facet only contains "Action > 2022". Only supported on textual fields. Maximum is 10.
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. Only supported on textual fields. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "restricted_values" to "Action > 2022", the "category" facet only contains "Action > 2022". Only supported on textual fields. Maximum is 10.
repeated string restricted_values = 3;getRestrictedValuesBytes in interface SearchRequest.FacetSpec.FacetKeyOrBuilderindex - The index of the value to return.public com.google.protobuf.ProtocolStringList getPrefixesList()
Only get facet values that start with the given string prefix. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the "category" facet only contains "Action > 2022" and "Action > 2021". Only supported on textual fields. Maximum is 10.
repeated string prefixes = 4;getPrefixesList in interface SearchRequest.FacetSpec.FacetKeyOrBuilderpublic int getPrefixesCount()
Only get facet values that start with the given string prefix. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the "category" facet only contains "Action > 2022" and "Action > 2021". Only supported on textual fields. Maximum is 10.
repeated string prefixes = 4;getPrefixesCount in interface SearchRequest.FacetSpec.FacetKeyOrBuilderpublic String getPrefixes(int index)
Only get facet values that start with the given string prefix. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the "category" facet only contains "Action > 2022" and "Action > 2021". Only supported on textual fields. Maximum is 10.
repeated string prefixes = 4;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 "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the "category" facet only contains "Action > 2022" and "Action > 2021". Only supported on textual fields. Maximum is 10.
repeated string prefixes = 4;getPrefixesBytes in interface SearchRequest.FacetSpec.FacetKeyOrBuilderindex - The index of the value to return.public com.google.protobuf.ProtocolStringList getContainsList()
Only get facet values that contain the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10.
repeated string contains = 5;getContainsList in interface SearchRequest.FacetSpec.FacetKeyOrBuilderpublic int getContainsCount()
Only get facet values that contain the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10.
repeated string contains = 5;getContainsCount in interface SearchRequest.FacetSpec.FacetKeyOrBuilderpublic String getContains(int index)
Only get facet values that contain the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10.
repeated string contains = 5;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 contain the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10.
repeated string contains = 5;getContainsBytes in interface SearchRequest.FacetSpec.FacetKeyOrBuilderindex - The index of the value to return.public boolean getCaseInsensitive()
True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
bool case_insensitive = 6;getCaseInsensitive in interface SearchRequest.FacetSpec.FacetKeyOrBuilderpublic String getOrderBy()
The order in which documents are returned. Allowed values are: * "count desc", which means order by [SearchResponse.Facet.values.count][google.cloud.discoveryengine.v1beta.SearchResponse.Facet.FacetValue.count] descending. * "value desc", which means order by [SearchResponse.Facet.values.value][google.cloud.discoveryengine.v1beta.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.discoveryengine.v1beta.SearchRequest.FacetSpec.FacetKey.intervals].
string order_by = 7;getOrderBy in interface SearchRequest.FacetSpec.FacetKeyOrBuilderpublic com.google.protobuf.ByteString getOrderByBytes()
The order in which documents are returned. Allowed values are: * "count desc", which means order by [SearchResponse.Facet.values.count][google.cloud.discoveryengine.v1beta.SearchResponse.Facet.FacetValue.count] descending. * "value desc", which means order by [SearchResponse.Facet.values.value][google.cloud.discoveryengine.v1beta.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.discoveryengine.v1beta.SearchRequest.FacetSpec.FacetKey.intervals].
string order_by = 7;getOrderByBytes in interface SearchRequest.FacetSpec.FacetKeyOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static SearchRequest.FacetSpec.FacetKey parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static SearchRequest.FacetSpec.FacetKey parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static SearchRequest.FacetSpec.FacetKey parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static SearchRequest.FacetSpec.FacetKey parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static SearchRequest.FacetSpec.FacetKey parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static SearchRequest.FacetSpec.FacetKey parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static SearchRequest.FacetSpec.FacetKey parseFrom(InputStream input) throws IOException
IOExceptionpublic static SearchRequest.FacetSpec.FacetKey parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static SearchRequest.FacetSpec.FacetKey parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static SearchRequest.FacetSpec.FacetKey parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static SearchRequest.FacetSpec.FacetKey parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static SearchRequest.FacetSpec.FacetKey parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic SearchRequest.FacetSpec.FacetKey.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static SearchRequest.FacetSpec.FacetKey.Builder newBuilder()
public static SearchRequest.FacetSpec.FacetKey.Builder newBuilder(SearchRequest.FacetSpec.FacetKey prototype)
public SearchRequest.FacetSpec.FacetKey.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected SearchRequest.FacetSpec.FacetKey.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static SearchRequest.FacetSpec.FacetKey getDefaultInstance()
public static com.google.protobuf.Parser<SearchRequest.FacetSpec.FacetKey> parser()
public com.google.protobuf.Parser<SearchRequest.FacetSpec.FacetKey> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public SearchRequest.FacetSpec.FacetKey getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2025 Google LLC. All rights reserved.