Package com.google.cloud.retail.v2

Interface CompleteQueryResponse.CompletionResultOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

CompleteQueryResponse.CompletionResult, CompleteQueryResponse.CompletionResult.Builder

Enclosing class:

CompleteQueryResponse

public static interface CompleteQueryResponse.CompletionResultOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method	Description
boolean	containsAttributes(String key)	Custom attributes for the suggestion term.
Map<String,CustomAttribute>	getAttributes()	Deprecated.
int	getAttributesCount()	Custom attributes for the suggestion term.
Map<String,CustomAttribute>	getAttributesMap()	Custom attributes for the suggestion term.
CustomAttribute	getAttributesOrDefault(String key, CustomAttribute defaultValue)	Custom attributes for the suggestion term.
CustomAttribute	getAttributesOrThrow(String key)	Custom attributes for the suggestion term.
String	getSuggestion()	The suggestion for the query.
com.google.protobuf.ByteString	getSuggestionBytes()	The suggestion for the query.

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Detail

getSuggestion

String getSuggestion()

 The suggestion for the query.
 

string suggestion = 1;

Returns:

The suggestion.

getSuggestionBytes

com.google.protobuf.ByteString getSuggestionBytes()

 The suggestion for the query.
 

string suggestion = 1;

Returns:

The bytes for suggestion.

getAttributesCount

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][google.cloud.retail.v2.UserEvent.product_details]
 is imported properly.
 

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

containsAttributes

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][google.cloud.retail.v2.UserEvent.product_details]
 is imported properly.
 

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

getAttributes

@Deprecated
Map<String,CustomAttribute> getAttributes()

Deprecated.

Use getAttributesMap() instead.

getAttributesMap

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][google.cloud.retail.v2.UserEvent.product_details]
 is imported properly.
 

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

getAttributesOrDefault

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][google.cloud.retail.v2.UserEvent.product_details]
 is imported properly.
 

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

getAttributesOrThrow

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][google.cloud.retail.v2.UserEvent.product_details]
 is imported properly.
 

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