Class SearchRequest.FacetSpec.FacetKey.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderT>
-
- com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.FacetKey.Builder>
-
- com.google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec.FacetKey.Builder
-
- All Implemented Interfaces:
SearchRequest.FacetSpec.FacetKeyOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
- SearchRequest.FacetSpec.FacetKey
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 typegoogle.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec.FacetKey
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description SearchRequest.FacetSpec.FacetKey.BuilderaddAllContains(Iterable<String> values)Only get facet values that contains the given strings.SearchRequest.FacetSpec.FacetKey.BuilderaddAllIntervals(Iterable<? extends Interval> values)Set only if values should be bucketed into intervals.SearchRequest.FacetSpec.FacetKey.BuilderaddAllPrefixes(Iterable<String> values)Only get facet values that start with the given string prefix.SearchRequest.FacetSpec.FacetKey.BuilderaddAllRestrictedValues(Iterable<String> values)Only get facet for the given restricted values.SearchRequest.FacetSpec.FacetKey.BuilderaddContains(String value)Only get facet values that contains the given strings.SearchRequest.FacetSpec.FacetKey.BuilderaddContainsBytes(com.google.protobuf.ByteString value)Only get facet values that contains the given strings.SearchRequest.FacetSpec.FacetKey.BuilderaddIntervals(int index, Interval value)Set only if values should be bucketed into intervals.SearchRequest.FacetSpec.FacetKey.BuilderaddIntervals(int index, Interval.Builder builderForValue)Set only if values should be bucketed into intervals.SearchRequest.FacetSpec.FacetKey.BuilderaddIntervals(Interval value)Set only if values should be bucketed into intervals.SearchRequest.FacetSpec.FacetKey.BuilderaddIntervals(Interval.Builder builderForValue)Set only if values should be bucketed into intervals.Interval.BuilderaddIntervalsBuilder()Set only if values should be bucketed into intervals.Interval.BuilderaddIntervalsBuilder(int index)Set only if values should be bucketed into intervals.SearchRequest.FacetSpec.FacetKey.BuilderaddPrefixes(String value)Only get facet values that start with the given string prefix.SearchRequest.FacetSpec.FacetKey.BuilderaddPrefixesBytes(com.google.protobuf.ByteString value)Only get facet values that start with the given string prefix.SearchRequest.FacetSpec.FacetKey.BuilderaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)SearchRequest.FacetSpec.FacetKey.BuilderaddRestrictedValues(String value)Only get facet for the given restricted values.SearchRequest.FacetSpec.FacetKey.BuilderaddRestrictedValuesBytes(com.google.protobuf.ByteString value)Only get facet for the given restricted values.SearchRequest.FacetSpec.FacetKeybuild()SearchRequest.FacetSpec.FacetKeybuildPartial()SearchRequest.FacetSpec.FacetKey.Builderclear()SearchRequest.FacetSpec.FacetKey.BuilderclearCaseInsensitive()True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.SearchRequest.FacetSpec.FacetKey.BuilderclearContains()Only get facet values that contains the given strings.SearchRequest.FacetSpec.FacetKey.BuilderclearField(com.google.protobuf.Descriptors.FieldDescriptor field)SearchRequest.FacetSpec.FacetKey.BuilderclearIntervals()Set only if values should be bucketed into intervals.SearchRequest.FacetSpec.FacetKey.BuilderclearKey()Required.SearchRequest.FacetSpec.FacetKey.BuilderclearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)SearchRequest.FacetSpec.FacetKey.BuilderclearOrderBy()The order in which documents are returned.SearchRequest.FacetSpec.FacetKey.BuilderclearPrefixes()Only get facet values that start with the given string prefix.SearchRequest.FacetSpec.FacetKey.BuilderclearRestrictedValues()Only get facet for the given restricted values.SearchRequest.FacetSpec.FacetKey.Builderclone()booleangetCaseInsensitive()True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.StringgetContains(int index)Only get facet values that contains the given strings.com.google.protobuf.ByteStringgetContainsBytes(int index)Only get facet values that contains the given strings.intgetContainsCount()Only get facet values that contains the given strings.com.google.protobuf.ProtocolStringListgetContainsList()Only get facet values that contains the given strings.SearchRequest.FacetSpec.FacetKeygetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()com.google.protobuf.Descriptors.DescriptorgetDescriptorForType()IntervalgetIntervals(int index)Set only if values should be bucketed into intervals.Interval.BuildergetIntervalsBuilder(int index)Set only if values should be bucketed into intervals.List<Interval.Builder>getIntervalsBuilderList()Set only if values should be bucketed into intervals.intgetIntervalsCount()Set only if values should be bucketed into intervals.List<Interval>getIntervalsList()Set only if values should be bucketed into intervals.IntervalOrBuildergetIntervalsOrBuilder(int index)Set only if values should be bucketed into intervals.List<? extends IntervalOrBuilder>getIntervalsOrBuilderList()Set only if values should be bucketed into intervals.StringgetKey()Required.com.google.protobuf.ByteStringgetKeyBytes()Required.StringgetOrderBy()The order in which documents are returned.com.google.protobuf.ByteStringgetOrderByBytes()The order in which documents are returned.StringgetPrefixes(int index)Only get facet values that start with the given string prefix.com.google.protobuf.ByteStringgetPrefixesBytes(int index)Only get facet values that start with the given string prefix.intgetPrefixesCount()Only get facet values that start with the given string prefix.com.google.protobuf.ProtocolStringListgetPrefixesList()Only get facet values that start with the given string prefix.StringgetRestrictedValues(int index)Only get facet for the given restricted values.com.google.protobuf.ByteStringgetRestrictedValuesBytes(int index)Only get facet for the given restricted values.intgetRestrictedValuesCount()Only get facet for the given restricted values.com.google.protobuf.ProtocolStringListgetRestrictedValuesList()Only get facet for the given restricted values.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()booleanisInitialized()SearchRequest.FacetSpec.FacetKey.BuildermergeFrom(SearchRequest.FacetSpec.FacetKey other)SearchRequest.FacetSpec.FacetKey.BuildermergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)SearchRequest.FacetSpec.FacetKey.BuildermergeFrom(com.google.protobuf.Message other)SearchRequest.FacetSpec.FacetKey.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)SearchRequest.FacetSpec.FacetKey.BuilderremoveIntervals(int index)Set only if values should be bucketed into intervals.SearchRequest.FacetSpec.FacetKey.BuildersetCaseInsensitive(boolean value)True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.SearchRequest.FacetSpec.FacetKey.BuildersetContains(int index, String value)Only get facet values that contains the given strings.SearchRequest.FacetSpec.FacetKey.BuildersetField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)SearchRequest.FacetSpec.FacetKey.BuildersetIntervals(int index, Interval value)Set only if values should be bucketed into intervals.SearchRequest.FacetSpec.FacetKey.BuildersetIntervals(int index, Interval.Builder builderForValue)Set only if values should be bucketed into intervals.SearchRequest.FacetSpec.FacetKey.BuildersetKey(String value)Required.SearchRequest.FacetSpec.FacetKey.BuildersetKeyBytes(com.google.protobuf.ByteString value)Required.SearchRequest.FacetSpec.FacetKey.BuildersetOrderBy(String value)The order in which documents are returned.SearchRequest.FacetSpec.FacetKey.BuildersetOrderByBytes(com.google.protobuf.ByteString value)The order in which documents are returned.SearchRequest.FacetSpec.FacetKey.BuildersetPrefixes(int index, String value)Only get facet values that start with the given string prefix.SearchRequest.FacetSpec.FacetKey.BuildersetRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)SearchRequest.FacetSpec.FacetKey.BuildersetRestrictedValues(int index, String value)Only get facet for the given restricted values.SearchRequest.FacetSpec.FacetKey.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)-
Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.FacetKey.Builder>
-
clear
public SearchRequest.FacetSpec.FacetKey.Builder clear()
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.FacetKey.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.FacetKey.Builder>
-
getDefaultInstanceForType
public SearchRequest.FacetSpec.FacetKey getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
public SearchRequest.FacetSpec.FacetKey build()
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public SearchRequest.FacetSpec.FacetKey buildPartial()
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
public SearchRequest.FacetSpec.FacetKey.Builder clone()
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.FacetKey.Builder>
-
setField
public SearchRequest.FacetSpec.FacetKey.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.FacetKey.Builder>
-
clearField
public SearchRequest.FacetSpec.FacetKey.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.FacetKey.Builder>
-
clearOneof
public SearchRequest.FacetSpec.FacetKey.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.FacetKey.Builder>
-
setRepeatedField
public SearchRequest.FacetSpec.FacetKey.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
- Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.FacetKey.Builder>
-
addRepeatedField
public SearchRequest.FacetSpec.FacetKey.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.FacetKey.Builder>
-
mergeFrom
public SearchRequest.FacetSpec.FacetKey.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<SearchRequest.FacetSpec.FacetKey.Builder>
-
mergeFrom
public SearchRequest.FacetSpec.FacetKey.Builder mergeFrom(SearchRequest.FacetSpec.FacetKey other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.FacetKey.Builder>
-
mergeFrom
public SearchRequest.FacetSpec.FacetKey.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<SearchRequest.FacetSpec.FacetKey.Builder>- Throws:
IOException
-
getKey
public 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];- Specified by:
getKeyin interfaceSearchRequest.FacetSpec.FacetKeyOrBuilder- Returns:
- The key.
-
getKeyBytes
public 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];- Specified by:
getKeyBytesin interfaceSearchRequest.FacetSpec.FacetKeyOrBuilder- Returns:
- The bytes for key.
-
setKey
public SearchRequest.FacetSpec.FacetKey.Builder setKey(String value)
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];- Parameters:
value- The key to set.- Returns:
- This builder for chaining.
-
clearKey
public SearchRequest.FacetSpec.FacetKey.Builder clearKey()
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];- Returns:
- This builder for chaining.
-
setKeyBytes
public SearchRequest.FacetSpec.FacetKey.Builder setKeyBytes(com.google.protobuf.ByteString value)
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];- Parameters:
value- The bytes for key to set.- Returns:
- This builder for chaining.
-
getIntervalsList
public 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;- Specified by:
getIntervalsListin interfaceSearchRequest.FacetSpec.FacetKeyOrBuilder
-
getIntervalsCount
public 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;- Specified by:
getIntervalsCountin interfaceSearchRequest.FacetSpec.FacetKeyOrBuilder
-
getIntervals
public 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;- Specified by:
getIntervalsin interfaceSearchRequest.FacetSpec.FacetKeyOrBuilder
-
setIntervals
public SearchRequest.FacetSpec.FacetKey.Builder setIntervals(int index, Interval value)
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;
-
setIntervals
public SearchRequest.FacetSpec.FacetKey.Builder setIntervals(int index, Interval.Builder builderForValue)
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;
-
addIntervals
public SearchRequest.FacetSpec.FacetKey.Builder addIntervals(Interval value)
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;
-
addIntervals
public SearchRequest.FacetSpec.FacetKey.Builder addIntervals(int index, Interval value)
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;
-
addIntervals
public SearchRequest.FacetSpec.FacetKey.Builder addIntervals(Interval.Builder builderForValue)
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;
-
addIntervals
public SearchRequest.FacetSpec.FacetKey.Builder addIntervals(int index, Interval.Builder builderForValue)
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;
-
addAllIntervals
public SearchRequest.FacetSpec.FacetKey.Builder addAllIntervals(Iterable<? extends Interval> values)
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;
-
clearIntervals
public SearchRequest.FacetSpec.FacetKey.Builder clearIntervals()
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;
-
removeIntervals
public SearchRequest.FacetSpec.FacetKey.Builder removeIntervals(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;
-
getIntervalsBuilder
public Interval.Builder getIntervalsBuilder(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
public 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;- Specified by:
getIntervalsOrBuilderin interfaceSearchRequest.FacetSpec.FacetKeyOrBuilder
-
getIntervalsOrBuilderList
public 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;- Specified by:
getIntervalsOrBuilderListin interfaceSearchRequest.FacetSpec.FacetKeyOrBuilder
-
addIntervalsBuilder
public Interval.Builder addIntervalsBuilder()
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;
-
addIntervalsBuilder
public Interval.Builder addIntervalsBuilder(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;
-
getIntervalsBuilderList
public List<Interval.Builder> getIntervalsBuilderList()
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;
-
getRestrictedValuesList
public 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;- Specified by:
getRestrictedValuesListin interfaceSearchRequest.FacetSpec.FacetKeyOrBuilder- Returns:
- A list containing the restrictedValues.
-
getRestrictedValuesCount
public 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;- Specified by:
getRestrictedValuesCountin interfaceSearchRequest.FacetSpec.FacetKeyOrBuilder- Returns:
- The count of restrictedValues.
-
getRestrictedValues
public 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;- Specified by:
getRestrictedValuesin interfaceSearchRequest.FacetSpec.FacetKeyOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The restrictedValues at the given index.
-
getRestrictedValuesBytes
public com.google.protobuf.ByteString getRestrictedValuesBytes(int index)
Only get facet for the given restricted values. 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;- Specified by:
getRestrictedValuesBytesin interfaceSearchRequest.FacetSpec.FacetKeyOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the restrictedValues at the given index.
-
setRestrictedValues
public SearchRequest.FacetSpec.FacetKey.Builder setRestrictedValues(int index, String value)
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;- Parameters:
index- The index to set the value at.value- The restrictedValues to set.- Returns:
- This builder for chaining.
-
addRestrictedValues
public SearchRequest.FacetSpec.FacetKey.Builder addRestrictedValues(String value)
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;- Parameters:
value- The restrictedValues to add.- Returns:
- This builder for chaining.
-
addAllRestrictedValues
public SearchRequest.FacetSpec.FacetKey.Builder addAllRestrictedValues(Iterable<String> values)
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;- Parameters:
values- The restrictedValues to add.- Returns:
- This builder for chaining.
-
clearRestrictedValues
public SearchRequest.FacetSpec.FacetKey.Builder clearRestrictedValues()
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;- Returns:
- This builder for chaining.
-
addRestrictedValuesBytes
public SearchRequest.FacetSpec.FacetKey.Builder addRestrictedValuesBytes(com.google.protobuf.ByteString value)
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;- Parameters:
value- The bytes of the restrictedValues to add.- Returns:
- This builder for chaining.
-
getPrefixesList
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;- Specified by:
getPrefixesListin interfaceSearchRequest.FacetSpec.FacetKeyOrBuilder- Returns:
- A list containing the prefixes.
-
getPrefixesCount
public int getPrefixesCount()
Only get facet values that start with the given string prefix. For example, suppose "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;- Specified by:
getPrefixesCountin interfaceSearchRequest.FacetSpec.FacetKeyOrBuilder- Returns:
- The count of prefixes.
-
getPrefixes
public String getPrefixes(int index)
Only get facet values that start with the given string prefix. For example, suppose "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;- Specified by:
getPrefixesin interfaceSearchRequest.FacetSpec.FacetKeyOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The prefixes at the given index.
-
getPrefixesBytes
public com.google.protobuf.ByteString getPrefixesBytes(int index)
Only get facet values that start with the given string prefix. For example, suppose "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;- Specified by:
getPrefixesBytesin interfaceSearchRequest.FacetSpec.FacetKeyOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the prefixes at the given index.
-
setPrefixes
public SearchRequest.FacetSpec.FacetKey.Builder setPrefixes(int index, String value)
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;- Parameters:
index- The index to set the value at.value- The prefixes to set.- Returns:
- This builder for chaining.
-
addPrefixes
public SearchRequest.FacetSpec.FacetKey.Builder addPrefixes(String value)
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;- Parameters:
value- The prefixes to add.- Returns:
- This builder for chaining.
-
addAllPrefixes
public SearchRequest.FacetSpec.FacetKey.Builder addAllPrefixes(Iterable<String> values)
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;- Parameters:
values- The prefixes to add.- Returns:
- This builder for chaining.
-
clearPrefixes
public SearchRequest.FacetSpec.FacetKey.Builder clearPrefixes()
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;- Returns:
- This builder for chaining.
-
addPrefixesBytes
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 "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;- Parameters:
value- The bytes of the prefixes to add.- Returns:
- This builder for chaining.
-
getContainsList
public com.google.protobuf.ProtocolStringList getContainsList()
Only get facet values that contains 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;- Specified by:
getContainsListin interfaceSearchRequest.FacetSpec.FacetKeyOrBuilder- Returns:
- A list containing the contains.
-
getContainsCount
public int getContainsCount()
Only get facet values that contains 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;- Specified by:
getContainsCountin interfaceSearchRequest.FacetSpec.FacetKeyOrBuilder- Returns:
- The count of contains.
-
getContains
public String getContains(int index)
Only get facet values that contains the given strings. For example, suppose "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;- Specified by:
getContainsin interfaceSearchRequest.FacetSpec.FacetKeyOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The contains at the given index.
-
getContainsBytes
public com.google.protobuf.ByteString getContainsBytes(int index)
Only get facet values that contains the given strings. For example, suppose "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;- Specified by:
getContainsBytesin interfaceSearchRequest.FacetSpec.FacetKeyOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the contains at the given index.
-
setContains
public SearchRequest.FacetSpec.FacetKey.Builder setContains(int index, String value)
Only get facet values that contains 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;- Parameters:
index- The index to set the value at.value- The contains to set.- Returns:
- This builder for chaining.
-
addContains
public SearchRequest.FacetSpec.FacetKey.Builder addContains(String value)
Only get facet values that contains 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;- Parameters:
value- The contains to add.- Returns:
- This builder for chaining.
-
addAllContains
public SearchRequest.FacetSpec.FacetKey.Builder addAllContains(Iterable<String> values)
Only get facet values that contains 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;- Parameters:
values- The contains to add.- Returns:
- This builder for chaining.
-
clearContains
public SearchRequest.FacetSpec.FacetKey.Builder clearContains()
Only get facet values that contains 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;- Returns:
- This builder for chaining.
-
addContainsBytes
public SearchRequest.FacetSpec.FacetKey.Builder addContainsBytes(com.google.protobuf.ByteString value)
Only get facet values that contains 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;- Parameters:
value- The bytes of the contains to add.- Returns:
- This builder for chaining.
-
getCaseInsensitive
public boolean getCaseInsensitive()
True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
bool case_insensitive = 6;- Specified by:
getCaseInsensitivein interfaceSearchRequest.FacetSpec.FacetKeyOrBuilder- Returns:
- The caseInsensitive.
-
setCaseInsensitive
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 = 6;- Parameters:
value- The caseInsensitive to set.- Returns:
- This builder for chaining.
-
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 = 6;- Returns:
- This builder for chaining.
-
getOrderBy
public 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;- Specified by:
getOrderByin interfaceSearchRequest.FacetSpec.FacetKeyOrBuilder- Returns:
- The orderBy.
-
getOrderByBytes
public 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;- Specified by:
getOrderByBytesin interfaceSearchRequest.FacetSpec.FacetKeyOrBuilder- Returns:
- The bytes for orderBy.
-
setOrderBy
public SearchRequest.FacetSpec.FacetKey.Builder setOrderBy(String value)
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;- Parameters:
value- The orderBy to set.- Returns:
- This builder for chaining.
-
clearOrderBy
public SearchRequest.FacetSpec.FacetKey.Builder clearOrderBy()
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;- Returns:
- This builder for chaining.
-
setOrderByBytes
public SearchRequest.FacetSpec.FacetKey.Builder setOrderByBytes(com.google.protobuf.ByteString value)
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;- Parameters:
value- The bytes for orderBy to set.- Returns:
- This builder for chaining.
-
setUnknownFields
public final SearchRequest.FacetSpec.FacetKey.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.FacetKey.Builder>
-
mergeUnknownFields
public final SearchRequest.FacetSpec.FacetKey.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.FacetKey.Builder>
-
-