Interface CompleteQueryResponse.CompletionResultOrBuilder (2.26.0)

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.v2.CustomAttribute> attributes = 2;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getAttributes()

public abstract Map<String,CustomAttribute> getAttributes()

Use #getAttributesMap() instead.

Returns
TypeDescription
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.v2.CustomAttribute> attributes = 2;

Returns
TypeDescription
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.v2.CustomAttribute> attributes = 2;

Returns
TypeDescription
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.v2.CustomAttribute> attributes = 2;

Parameters
NameDescription
keyString
defaultValueCustomAttribute
Returns
TypeDescription
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.v2.CustomAttribute> attributes = 2;

Parameter
NameDescription
keyString
Returns
TypeDescription
CustomAttribute

getSuggestion()

public abstract String getSuggestion()

The suggestion for the query.

string suggestion = 1;

Returns
TypeDescription
String

The suggestion.

getSuggestionBytes()

public abstract ByteString getSuggestionBytes()

The suggestion for the query.

string suggestion = 1;

Returns
TypeDescription
ByteString

The bytes for suggestion.