Interface CompleteQueryResponse.CompletionResultOrBuilder (2.55.0)

Version 2.55.0

• 2.56.0 (latest)
• 2.55.0
• 2.54.0
• 2.53.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.1
• 2.4.0
• 2.3.0
• 2.2.3
• 2.1.0
• 2.0.19

public static interface CompleteQueryResponse.CompletionResultOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAttributes(String key)

public abstract boolean containsAttributes(String key)

Custom attributes for the suggestion term.

• For "user-data", the attributes are additional custom attributes ingested through BigQuery.

• For "cloud-retail", the attributes are product attributes generated by Cloud Retail. It requires UserEvent.product_details is imported properly.

map<string, .google.cloud.retail.v2alpha.CustomAttribute> attributes = 2;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getAttributes() (deprecated)

public abstract Map<String,CustomAttribute> getAttributes()

Use #getAttributesMap() instead.

Returns
Type	Description
Map<String,CustomAttribute>

getAttributesCount()

public abstract int getAttributesCount()

Custom attributes for the suggestion term.

• For "user-data", the attributes are additional custom attributes ingested through BigQuery.

• For "cloud-retail", the attributes are product attributes generated by Cloud Retail. It requires UserEvent.product_details is imported properly.

map<string, .google.cloud.retail.v2alpha.CustomAttribute> attributes = 2;

Returns
Type	Description
int

getAttributesMap()

public abstract Map<String,CustomAttribute> getAttributesMap()

Custom attributes for the suggestion term.

• For "user-data", the attributes are additional custom attributes ingested through BigQuery.

• For "cloud-retail", the attributes are product attributes generated by Cloud Retail. It requires UserEvent.product_details is imported properly.

map<string, .google.cloud.retail.v2alpha.CustomAttribute> attributes = 2;

Returns
Type	Description
Map<String,CustomAttribute>

getAttributesOrDefault(String key, CustomAttribute defaultValue)

public abstract CustomAttribute getAttributesOrDefault(String key, CustomAttribute defaultValue)

Custom attributes for the suggestion term.

• For "user-data", the attributes are additional custom attributes ingested through BigQuery.

• For "cloud-retail", the attributes are product attributes generated by Cloud Retail. It requires UserEvent.product_details is imported properly.

map<string, .google.cloud.retail.v2alpha.CustomAttribute> attributes = 2;

Parameters
Name	Description
key	String
defaultValue	CustomAttribute

Returns
Type	Description
CustomAttribute

getAttributesOrThrow(String key)

public abstract CustomAttribute getAttributesOrThrow(String key)

Custom attributes for the suggestion term.

• For "user-data", the attributes are additional custom attributes ingested through BigQuery.

• For "cloud-retail", the attributes are product attributes generated by Cloud Retail. It requires UserEvent.product_details is imported properly.

map<string, .google.cloud.retail.v2alpha.CustomAttribute> attributes = 2;

Parameter
Name	Description
key	String

Returns
Type	Description
CustomAttribute

getFacets(int index)

public abstract SearchResponse.Facet getFacets(int index)

Facet information for the suggestion term. Gives the number of items resulting from a search with this suggestion term for each facet.

This is an experimental feature for limited customers. If you want to receive this facet information, reach out to the Retail support team.

repeated .google.cloud.retail.v2alpha.SearchResponse.Facet facets = 3;

Parameter
Name	Description
index	int

Returns
Type	Description
SearchResponse.Facet

getFacetsCount()

public abstract int getFacetsCount()

Facet information for the suggestion term. Gives the number of items resulting from a search with this suggestion term for each facet.

This is an experimental feature for limited customers. If you want to receive this facet information, reach out to the Retail support team.

repeated .google.cloud.retail.v2alpha.SearchResponse.Facet facets = 3;

Returns
Type	Description
int

getFacetsList()

public abstract List<SearchResponse.Facet> getFacetsList()

Facet information for the suggestion term. Gives the number of items resulting from a search with this suggestion term for each facet.

This is an experimental feature for limited customers. If you want to receive this facet information, reach out to the Retail support team.

repeated .google.cloud.retail.v2alpha.SearchResponse.Facet facets = 3;

Returns
Type	Description
List<Facet>

getFacetsOrBuilder(int index)

public abstract SearchResponse.FacetOrBuilder getFacetsOrBuilder(int index)

Facet information for the suggestion term. Gives the number of items resulting from a search with this suggestion term for each facet.

This is an experimental feature for limited customers. If you want to receive this facet information, reach out to the Retail support team.

repeated .google.cloud.retail.v2alpha.SearchResponse.Facet facets = 3;

Parameter
Name	Description
index	int

Returns
Type	Description
SearchResponse.FacetOrBuilder

getFacetsOrBuilderList()

public abstract List<? extends SearchResponse.FacetOrBuilder> getFacetsOrBuilderList()

Facet information for the suggestion term. Gives the number of items resulting from a search with this suggestion term for each facet.

This is an experimental feature for limited customers. If you want to receive this facet information, reach out to the Retail support team.

repeated .google.cloud.retail.v2alpha.SearchResponse.Facet facets = 3;

Returns
Type	Description
List<? extends com.google.cloud.retail.v2alpha.SearchResponse.FacetOrBuilder>

getSuggestion()

public abstract String getSuggestion()

The suggestion for the query.

string suggestion = 1;

Returns
Type	Description
String	The suggestion.

getSuggestionBytes()

public abstract ByteString getSuggestionBytes()

The suggestion for the query.

string suggestion = 1;

Returns
Type	Description
ByteString	The bytes for suggestion.

getTotalProductCount()

public abstract int getTotalProductCount()

Total number of products associated with a search with this suggestion.

This is an experimental feature for limited customers. If you want to receive this product count information, reach out to the Retail support team.

int32 total_product_count = 4;

Returns
Type	Description
int	The totalProductCount.