Interface SearchResponse.FacetOrBuilder (0.20.0)

public static interface SearchResponse.FacetOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDynamicFacet()

public abstract boolean getDynamicFacet()

Whether the facet is dynamically generated.

bool dynamic_facet = 3;

Returns
TypeDescription
boolean

The dynamicFacet.

getKey()

public abstract String getKey()

The key for this facet. E.g., "colors" or "price". It matches SearchRequest.FacetSpec.FacetKey.key.

string key = 1;

Returns
TypeDescription
String

The key.

getKeyBytes()

public abstract ByteString getKeyBytes()

The key for this facet. E.g., "colors" or "price". It matches SearchRequest.FacetSpec.FacetKey.key.

string key = 1;

Returns
TypeDescription
ByteString

The bytes for key.

getValues(int index)

public abstract SearchResponse.Facet.FacetValue getValues(int index)

The facet values for this field.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Facet.FacetValue values = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
SearchResponse.Facet.FacetValue

getValuesCount()

public abstract int getValuesCount()

The facet values for this field.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Facet.FacetValue values = 2;

Returns
TypeDescription
int

getValuesList()

public abstract List<SearchResponse.Facet.FacetValue> getValuesList()

The facet values for this field.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Facet.FacetValue values = 2;

Returns
TypeDescription
List<FacetValue>

getValuesOrBuilder(int index)

public abstract SearchResponse.Facet.FacetValueOrBuilder getValuesOrBuilder(int index)

The facet values for this field.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Facet.FacetValue values = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
SearchResponse.Facet.FacetValueOrBuilder

getValuesOrBuilderList()

public abstract List<? extends SearchResponse.Facet.FacetValueOrBuilder> getValuesOrBuilderList()

The facet values for this field.

repeated .google.cloud.discoveryengine.v1.SearchResponse.Facet.FacetValue values = 2;

Returns
TypeDescription
List<? extends com.google.cloud.discoveryengine.v1.SearchResponse.Facet.FacetValueOrBuilder>