com.google.cloud.retail.v2alpha

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 and 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
SearchResponse.Facet	getFacets(int index) Facet information for the suggestion term.
int	getFacetsCount() Facet information for the suggestion term.
List<SearchResponse.Facet>	getFacetsList() Facet information for the suggestion term.
SearchResponse.FacetOrBuilder	getFacetsOrBuilder(int index) Facet information for the suggestion term.
List<? extends SearchResponse.FacetOrBuilder>	getFacetsOrBuilderList() Facet information for the suggestion term.
String	getSuggestion() The suggestion for the query.
com.google.protobuf.ByteString	getSuggestionBytes() The suggestion for the query.
int	getTotalProductCount() Total number of products associated with a search with this suggestion.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

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.v2alpha.UserEvent.product_details]
 is imported properly.
 

map<string, .google.cloud.retail.v2alpha.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.v2alpha.UserEvent.product_details]
 is imported properly.
 

map<string, .google.cloud.retail.v2alpha.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.v2alpha.UserEvent.product_details]
 is imported properly.
 

map<string, .google.cloud.retail.v2alpha.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.v2alpha.UserEvent.product_details]
 is imported properly.
 

map<string, .google.cloud.retail.v2alpha.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.v2alpha.UserEvent.product_details]
 is imported properly.
 

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

getFacetsList

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;

getFacets

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;

getFacetsCount

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;

getFacetsOrBuilderList

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;

getFacetsOrBuilder

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;

getTotalProductCount

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:

The totalProductCount.