public static final class SearchRequest.FacetSpec.FacetKey.Builder extends GeneratedMessageV3.Builder<SearchRequest.FacetSpec.FacetKey.Builder> implements SearchRequest.FacetSpec.FacetKeyOrBuilderSpecifies how a facet is computed.
Protobuf type google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec.FacetKey
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchRequest.FacetSpec.FacetKey.BuilderImplements
SearchRequest.FacetSpec.FacetKeyOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllContains(Iterable<String> values)
public SearchRequest.FacetSpec.FacetKey.Builder addAllContains(Iterable<String> values)Only get facet values that contains the given strings. For example, suppose "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;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The contains to add. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
This builder for chaining. |
addAllIntervals(Iterable<? extends Interval> values)
public SearchRequest.FacetSpec.FacetKey.Builder addAllIntervals(Iterable<? extends Interval> values)Set only if values should be 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;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.discoveryengine.v1beta.Interval> |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
|
addAllPrefixes(Iterable<String> values)
public SearchRequest.FacetSpec.FacetKey.Builder addAllPrefixes(Iterable<String> values)Only get facet values that start with the given string prefix. For example, suppose "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;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The prefixes to add. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
This builder for chaining. |
addAllRestrictedValues(Iterable<String> values)
public SearchRequest.FacetSpec.FacetKey.Builder addAllRestrictedValues(Iterable<String> values)Only get facet for the given restricted values. 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;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The restrictedValues to add. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
This builder for chaining. |
addContains(String value)
public SearchRequest.FacetSpec.FacetKey.Builder addContains(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe contains to add. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
This builder for chaining. |
addContainsBytes(ByteString value)
public SearchRequest.FacetSpec.FacetKey.Builder addContainsBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the contains to add. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
This builder for chaining. |
addIntervals(Interval value)
public SearchRequest.FacetSpec.FacetKey.Builder addIntervals(Interval value)Set only if values should be 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;
| Parameter | |
|---|---|
| Name | Description |
value |
Interval |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
|
addIntervals(Interval.Builder builderForValue)
public SearchRequest.FacetSpec.FacetKey.Builder addIntervals(Interval.Builder builderForValue)Set only if values should be 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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Interval.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
|
addIntervals(int index, Interval value)
public SearchRequest.FacetSpec.FacetKey.Builder addIntervals(int index, Interval value)Set only if values should be 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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Interval |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
|
addIntervals(int index, Interval.Builder builderForValue)
public SearchRequest.FacetSpec.FacetKey.Builder addIntervals(int index, Interval.Builder builderForValue)Set only if values should be 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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Interval.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
|
addIntervalsBuilder()
public Interval.Builder addIntervalsBuilder()Set only if values should be 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;
| Returns | |
|---|---|
| Type | Description |
Interval.Builder |
|
addIntervalsBuilder(int index)
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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Interval.Builder |
|
addPrefixes(String value)
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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe prefixes to add. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
This builder for chaining. |
addPrefixesBytes(ByteString value)
public SearchRequest.FacetSpec.FacetKey.Builder addPrefixesBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the prefixes to add. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SearchRequest.FacetSpec.FacetKey.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
|
addRestrictedValues(String value)
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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe restrictedValues to add. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
This builder for chaining. |
addRestrictedValuesBytes(ByteString value)
public SearchRequest.FacetSpec.FacetKey.Builder addRestrictedValuesBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the restrictedValues to add. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
This builder for chaining. |
build()
public SearchRequest.FacetSpec.FacetKey build()| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey |
|
buildPartial()
public SearchRequest.FacetSpec.FacetKey buildPartial()| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey |
|
clear()
public SearchRequest.FacetSpec.FacetKey.Builder clear()| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
|
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 | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
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 | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public SearchRequest.FacetSpec.FacetKey.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
|
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;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
|
clearKey()
public SearchRequest.FacetSpec.FacetKey.Builder clearKey()Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.
string key = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public SearchRequest.FacetSpec.FacetKey.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
|
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 descending.
"value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets.
If not set, textual values are sorted in natural order; numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.
string order_by = 7;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
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 | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
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 | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
This builder for chaining. |
clone()
public SearchRequest.FacetSpec.FacetKey.Builder clone()| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
|
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;
| Returns | |
|---|---|
| Type | Description |
boolean |
The caseInsensitive. |
getContains(int index)
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;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The contains at the given index. |
getContainsBytes(int index)
public 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;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the contains at the given index. |
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;
| Returns | |
|---|---|
| Type | Description |
int |
The count of contains. |
getContainsList()
public 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;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the contains. |
getDefaultInstanceForType()
public SearchRequest.FacetSpec.FacetKey getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getIntervals(int index)
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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Interval |
|
getIntervalsBuilder(int index)
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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Interval.Builder |
|
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;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
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;
| Returns | |
|---|---|
| Type | Description |
int |
|
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;
| Returns | |
|---|---|
| Type | Description |
List<Interval> |
|
getIntervalsOrBuilder(int index)
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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
IntervalOrBuilder |
|
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;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.discoveryengine.v1beta.IntervalOrBuilder> |
|
getKey()
public String getKey()Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.
string key = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The key. |
getKeyBytes()
public ByteString getKeyBytes()Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.
string key = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for key. |
getOrderBy()
public String getOrderBy()The order in which documents are returned.
Allowed values are:
"count desc", which means order by SearchResponse.Facet.values.count descending.
"value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets.
If not set, textual values are sorted in natural order; numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.
string order_by = 7;
| Returns | |
|---|---|
| Type | Description |
String |
The orderBy. |
getOrderByBytes()
public ByteString getOrderByBytes()The order in which documents are returned.
Allowed values are:
"count desc", which means order by SearchResponse.Facet.values.count descending.
"value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets.
If not set, textual values are sorted in natural order; numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.
string order_by = 7;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for orderBy. |
getPrefixes(int index)
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;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The prefixes at the given index. |
getPrefixesBytes(int index)
public 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;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the prefixes at the given index. |
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;
| Returns | |
|---|---|
| Type | Description |
int |
The count of prefixes. |
getPrefixesList()
public 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;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the prefixes. |
getRestrictedValues(int index)
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;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The restrictedValues at the given index. |
getRestrictedValuesBytes(int index)
public 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;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the restrictedValues at the given index. |
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;
| Returns | |
|---|---|
| Type | Description |
int |
The count of restrictedValues. |
getRestrictedValuesList()
public 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;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the restrictedValues. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(SearchRequest.FacetSpec.FacetKey other)
public SearchRequest.FacetSpec.FacetKey.Builder mergeFrom(SearchRequest.FacetSpec.FacetKey other)| Parameter | |
|---|---|
| Name | Description |
other |
SearchRequest.FacetSpec.FacetKey |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SearchRequest.FacetSpec.FacetKey.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public SearchRequest.FacetSpec.FacetKey.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SearchRequest.FacetSpec.FacetKey.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
|
removeIntervals(int index)
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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
|
setCaseInsensitive(boolean value)
public SearchRequest.FacetSpec.FacetKey.Builder setCaseInsensitive(boolean value)True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
bool case_insensitive = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe caseInsensitive to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
This builder for chaining. |
setContains(int index, String value)
public SearchRequest.FacetSpec.FacetKey.Builder setContains(int index, String value)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 | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe contains to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public SearchRequest.FacetSpec.FacetKey.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
|
setIntervals(int index, Interval value)
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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Interval |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
|
setIntervals(int index, Interval.Builder builderForValue)
public SearchRequest.FacetSpec.FacetKey.Builder setIntervals(int index, Interval.Builder builderForValue)Set only if values should be 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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Interval.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
|
setKey(String value)
public SearchRequest.FacetSpec.FacetKey.Builder setKey(String value)Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.
string key = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe key to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
This builder for chaining. |
setKeyBytes(ByteString value)
public SearchRequest.FacetSpec.FacetKey.Builder setKeyBytes(ByteString value)Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.
string key = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for key to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
This builder for chaining. |
setOrderBy(String value)
public SearchRequest.FacetSpec.FacetKey.Builder setOrderBy(String value)The order in which documents are returned.
Allowed values are:
"count desc", which means order by SearchResponse.Facet.values.count descending.
"value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets.
If not set, textual values are sorted in natural order; numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.
string order_by = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe orderBy to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
This builder for chaining. |
setOrderByBytes(ByteString value)
public SearchRequest.FacetSpec.FacetKey.Builder setOrderByBytes(ByteString value)The order in which documents are returned.
Allowed values are:
"count desc", which means order by SearchResponse.Facet.values.count descending.
"value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets.
If not set, textual values are sorted in natural order; numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.
string order_by = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for orderBy to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
This builder for chaining. |
setPrefixes(int index, String value)
public SearchRequest.FacetSpec.FacetKey.Builder setPrefixes(int index, String value)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 | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe prefixes to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SearchRequest.FacetSpec.FacetKey.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
|
setRestrictedValues(int index, String value)
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 | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe restrictedValues to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final SearchRequest.FacetSpec.FacetKey.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec.FacetKey.Builder |
|