Interface SearchRequest.FacetSpec.FacetKeyOrBuilder (0.29.0)

public static interface SearchRequest.FacetSpec.FacetKeyOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCaseInsensitive()

public abstract boolean getCaseInsensitive()

True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.

bool case_insensitive = 6;

Returns
TypeDescription
boolean

The caseInsensitive.

getContains(int index)

public abstract 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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The contains at the given index.

getContainsBytes(int index)

public abstract 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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the contains at the given index.

getContainsCount()

public abstract 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
TypeDescription
int

The count of contains.

getContainsList()

public abstract List<String> 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
TypeDescription
List<String>

A list containing the contains.

getIntervals(int index)

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Interval

getIntervalsCount()

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

Returns
TypeDescription
int

getIntervalsList()

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

Returns
TypeDescription
List<Interval>

getIntervalsOrBuilder(int index)

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

Parameter
NameDescription
indexint
Returns
TypeDescription
IntervalOrBuilder

getIntervalsOrBuilderList()

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

Returns
TypeDescription
List<? extends com.google.cloud.discoveryengine.v1alpha.IntervalOrBuilder>

getKey()

public abstract 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
TypeDescription
String

The key.

getKeyBytes()

public abstract 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
TypeDescription
ByteString

The bytes for key.

getOrderBy()

public abstract 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
TypeDescription
String

The orderBy.

getOrderByBytes()

public abstract 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
TypeDescription
ByteString

The bytes for orderBy.

getPrefixes(int index)

public abstract 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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The prefixes at the given index.

getPrefixesBytes(int index)

public abstract 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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the prefixes at the given index.

getPrefixesCount()

public abstract 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
TypeDescription
int

The count of prefixes.

getPrefixesList()

public abstract List<String> 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
TypeDescription
List<String>

A list containing the prefixes.

getRestrictedValues(int index)

public abstract 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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The restrictedValues at the given index.

getRestrictedValuesBytes(int index)

public abstract 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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the restrictedValues at the given index.

getRestrictedValuesCount()

public abstract 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
TypeDescription
int

The count of restrictedValues.

getRestrictedValuesList()

public abstract List<String> 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
TypeDescription
List<String>

A list containing the restrictedValues.