com.google.cloud.discoveryengine.v1alpha

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.v1alpha.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 type google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec.FacetKey

Method Summary

Modifier and Type	Method and Description
SearchRequest.FacetSpec.FacetKey.Builder	addAllContains(Iterable<String> values) Only get facet values that contain the given strings.
SearchRequest.FacetSpec.FacetKey.Builder	addAllIntervals(Iterable<? extends Interval> values) Set only if values should be bucketed into intervals.
SearchRequest.FacetSpec.FacetKey.Builder	addAllPrefixes(Iterable<String> values) Only get facet values that start with the given string prefix.
SearchRequest.FacetSpec.FacetKey.Builder	addAllRestrictedValues(Iterable<String> values) Only get facet for the given restricted values.
SearchRequest.FacetSpec.FacetKey.Builder	addContains(String value) Only get facet values that contain the given strings.
SearchRequest.FacetSpec.FacetKey.Builder	addContainsBytes(com.google.protobuf.ByteString value) Only get facet values that contain the given strings.
SearchRequest.FacetSpec.FacetKey.Builder	addIntervals(Interval.Builder builderForValue) Set only if values should be bucketed into intervals.
SearchRequest.FacetSpec.FacetKey.Builder	addIntervals(Interval value) Set only if values should be bucketed into intervals.
SearchRequest.FacetSpec.FacetKey.Builder	addIntervals(int index, Interval.Builder builderForValue) Set only if values should be bucketed into intervals.
SearchRequest.FacetSpec.FacetKey.Builder	addIntervals(int index, Interval value) Set only if values should be bucketed into intervals.
Interval.Builder	addIntervalsBuilder() Set only if values should be bucketed into intervals.
Interval.Builder	addIntervalsBuilder(int index) Set only if values should be bucketed into intervals.
SearchRequest.FacetSpec.FacetKey.Builder	addPrefixes(String value) Only get facet values that start with the given string prefix.
SearchRequest.FacetSpec.FacetKey.Builder	addPrefixesBytes(com.google.protobuf.ByteString value) Only get facet values that start with the given string prefix.
SearchRequest.FacetSpec.FacetKey.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
SearchRequest.FacetSpec.FacetKey.Builder	addRestrictedValues(String value) Only get facet for the given restricted values.
SearchRequest.FacetSpec.FacetKey.Builder	addRestrictedValuesBytes(com.google.protobuf.ByteString value) Only get facet for the given restricted values.
SearchRequest.FacetSpec.FacetKey	build()
SearchRequest.FacetSpec.FacetKey	buildPartial()
SearchRequest.FacetSpec.FacetKey.Builder	clear()
SearchRequest.FacetSpec.FacetKey.Builder	clearCaseInsensitive() True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
SearchRequest.FacetSpec.FacetKey.Builder	clearContains() Only get facet values that contain the given strings.
SearchRequest.FacetSpec.FacetKey.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
SearchRequest.FacetSpec.FacetKey.Builder	clearIntervals() Set only if values should be bucketed into intervals.
SearchRequest.FacetSpec.FacetKey.Builder	clearKey() Required.
SearchRequest.FacetSpec.FacetKey.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
SearchRequest.FacetSpec.FacetKey.Builder	clearOrderBy() The order in which documents are returned.
SearchRequest.FacetSpec.FacetKey.Builder	clearPrefixes() Only get facet values that start with the given string prefix.
SearchRequest.FacetSpec.FacetKey.Builder	clearRestrictedValues() Only get facet for the given restricted values.
SearchRequest.FacetSpec.FacetKey.Builder	clone()
boolean	getCaseInsensitive() True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
String	getContains(int index) Only get facet values that 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.
SearchRequest.FacetSpec.FacetKey	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
Interval	getIntervals(int index) Set only if values should be bucketed into intervals.
Interval.Builder	getIntervalsBuilder(int index) Set only if values should be bucketed into intervals.
List<Interval.Builder>	getIntervalsBuilderList() 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.
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.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
SearchRequest.FacetSpec.FacetKey.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
SearchRequest.FacetSpec.FacetKey.Builder	mergeFrom(com.google.protobuf.Message other)
SearchRequest.FacetSpec.FacetKey.Builder	mergeFrom(SearchRequest.FacetSpec.FacetKey other)
SearchRequest.FacetSpec.FacetKey.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
SearchRequest.FacetSpec.FacetKey.Builder	removeIntervals(int index) Set only if values should be bucketed into intervals.
SearchRequest.FacetSpec.FacetKey.Builder	setCaseInsensitive(boolean value) True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
SearchRequest.FacetSpec.FacetKey.Builder	setContains(int index, String value) Only get facet values that contain the given strings.
SearchRequest.FacetSpec.FacetKey.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
SearchRequest.FacetSpec.FacetKey.Builder	setIntervals(int index, Interval.Builder builderForValue) Set only if values should be bucketed into intervals.
SearchRequest.FacetSpec.FacetKey.Builder	setIntervals(int index, Interval value) Set only if values should be bucketed into intervals.
SearchRequest.FacetSpec.FacetKey.Builder	setKey(String value) Required.
SearchRequest.FacetSpec.FacetKey.Builder	setKeyBytes(com.google.protobuf.ByteString value) Required.
SearchRequest.FacetSpec.FacetKey.Builder	setOrderBy(String value) The order in which documents are returned.
SearchRequest.FacetSpec.FacetKey.Builder	setOrderByBytes(com.google.protobuf.ByteString value) The order in which documents are returned.
SearchRequest.FacetSpec.FacetKey.Builder	setPrefixes(int index, String value) Only get facet values that start with the given string prefix.
SearchRequest.FacetSpec.FacetKey.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
SearchRequest.FacetSpec.FacetKey.Builder	setRestrictedValues(int index, String value) Only get facet for the given restricted values.
SearchRequest.FacetSpec.FacetKey.Builder	setUnknownFields(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, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, 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, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

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.Builder<SearchRequest.FacetSpec.FacetKey.Builder>

clear

public SearchRequest.FacetSpec.FacetKey.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.FacetKey.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.FacetKey.Builder>

getDefaultInstanceForType

public SearchRequest.FacetSpec.FacetKey getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public SearchRequest.FacetSpec.FacetKey build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public SearchRequest.FacetSpec.FacetKey buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public SearchRequest.FacetSpec.FacetKey.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.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:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.FacetKey.Builder>

clearField

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

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.FacetKey.Builder>

clearOneof

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

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.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:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.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:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.FacetKey.Builder>

mergeFrom

public SearchRequest.FacetSpec.FacetKey.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.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:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.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:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.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.v1alpha.Document] object, over
 which the facet values are computed. Facet key is case-sensitive.
 

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

Specified by:

getKey in interface SearchRequest.FacetSpec.FacetKeyOrBuilder

Returns:

The key.

getKeyBytes

public com.google.protobuf.ByteString getKeyBytes()

 Required. Supported textual and numerical facet keys in
 [Document][google.cloud.discoveryengine.v1alpha.Document] object, over
 which the facet values are computed. Facet key is case-sensitive.
 

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

Specified by:

getKeyBytes in interface SearchRequest.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.Interval intervals = 2;

Specified by:

getIntervalsList in interface SearchRequest.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.v1alpha.Interval intervals = 2;

Specified by:

getIntervalsCount in interface SearchRequest.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.v1alpha.Interval intervals = 2;

Specified by:

getIntervals in interface SearchRequest.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.Interval intervals = 2;

Specified by:

getIntervalsOrBuilder in interface SearchRequest.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.v1alpha.Interval intervals = 2;

Specified by:

getIntervalsOrBuilderList in interface SearchRequest.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.v1alpha.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.v1alpha.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.v1alpha.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:

getRestrictedValuesList in interface SearchRequest.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:

getRestrictedValuesCount in interface SearchRequest.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:

getRestrictedValues in interface SearchRequest.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:

getRestrictedValuesBytes in interface SearchRequest.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:

getPrefixesList in interface SearchRequest.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:

getPrefixesCount in interface SearchRequest.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:

getPrefixes in interface SearchRequest.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:

getPrefixesBytes in interface SearchRequest.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 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;

Specified by:

getContainsList in interface SearchRequest.FacetSpec.FacetKeyOrBuilder

Returns:

A list containing the contains.

getContainsCount

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

Specified by:

getContainsCount in interface SearchRequest.FacetSpec.FacetKeyOrBuilder

Returns:

The count of contains.

getContains

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

Specified by:

getContains in interface SearchRequest.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 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;

Specified by:

getContainsBytes in interface SearchRequest.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 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;

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

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

Parameters:

values - The contains to add.

Returns:

This builder for chaining.

clearContains

public SearchRequest.FacetSpec.FacetKey.Builder clearContains()

 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;

Returns:

This builder for chaining.

addContainsBytes

public SearchRequest.FacetSpec.FacetKey.Builder addContainsBytes(com.google.protobuf.ByteString value)

 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;

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:

getCaseInsensitive in interface SearchRequest.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.v1alpha.SearchResponse.Facet.FacetValue.count]
 descending.

 * "value desc", which means order by
 [SearchResponse.Facet.values.value][google.cloud.discoveryengine.v1alpha.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.v1alpha.SearchRequest.FacetSpec.FacetKey.intervals].
 

string order_by = 7;

Specified by:

getOrderBy in interface SearchRequest.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.v1alpha.SearchResponse.Facet.FacetValue.count]
 descending.

 * "value desc", which means order by
 [SearchResponse.Facet.values.value][google.cloud.discoveryengine.v1alpha.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.v1alpha.SearchRequest.FacetSpec.FacetKey.intervals].
 

string order_by = 7;

Specified by:

getOrderByBytes in interface SearchRequest.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.v1alpha.SearchResponse.Facet.FacetValue.count]
 descending.

 * "value desc", which means order by
 [SearchResponse.Facet.values.value][google.cloud.discoveryengine.v1alpha.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.v1alpha.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.v1alpha.SearchResponse.Facet.FacetValue.count]
 descending.

 * "value desc", which means order by
 [SearchResponse.Facet.values.value][google.cloud.discoveryengine.v1alpha.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.v1alpha.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.v1alpha.SearchResponse.Facet.FacetValue.count]
 descending.

 * "value desc", which means order by
 [SearchResponse.Facet.values.value][google.cloud.discoveryengine.v1alpha.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.v1alpha.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:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.FacetKey.Builder>

mergeUnknownFields

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

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.FacetKey.Builder>