com.google.cloud.retail.v2beta

Interface CompleteQueryResponseOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

CompleteQueryResponse, CompleteQueryResponse.Builder

public interface CompleteQueryResponseOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getAttributionToken() A unique complete token.
com.google.protobuf.ByteString	getAttributionTokenBytes() A unique complete token.
CompleteQueryResponse.CompletionResult	getCompletionResults(int index) Results of the matching suggestions.
int	getCompletionResultsCount() Results of the matching suggestions.
List<CompleteQueryResponse.CompletionResult>	getCompletionResultsList() Results of the matching suggestions.
CompleteQueryResponse.CompletionResultOrBuilder	getCompletionResultsOrBuilder(int index) Results of the matching suggestions.
List<? extends CompleteQueryResponse.CompletionResultOrBuilder>	getCompletionResultsOrBuilderList() Results of the matching suggestions.
CompleteQueryResponse.RecentSearchResult	getRecentSearchResults(int index) Matched recent searches of this user.
int	getRecentSearchResultsCount() Matched recent searches of this user.
List<CompleteQueryResponse.RecentSearchResult>	getRecentSearchResultsList() Matched recent searches of this user.
CompleteQueryResponse.RecentSearchResultOrBuilder	getRecentSearchResultsOrBuilder(int index) Matched recent searches of this user.
List<? extends CompleteQueryResponse.RecentSearchResultOrBuilder>	getRecentSearchResultsOrBuilderList() Matched recent searches of this user.

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

getCompletionResultsList

List<CompleteQueryResponse.CompletionResult> getCompletionResultsList()

 Results of the matching suggestions. The result list is ordered and the
 first result is top suggestion.
 

repeated .google.cloud.retail.v2beta.CompleteQueryResponse.CompletionResult completion_results = 1;

getCompletionResults

CompleteQueryResponse.CompletionResult getCompletionResults(int index)

 Results of the matching suggestions. The result list is ordered and the
 first result is top suggestion.
 

repeated .google.cloud.retail.v2beta.CompleteQueryResponse.CompletionResult completion_results = 1;

getCompletionResultsCount

int getCompletionResultsCount()

 Results of the matching suggestions. The result list is ordered and the
 first result is top suggestion.
 

repeated .google.cloud.retail.v2beta.CompleteQueryResponse.CompletionResult completion_results = 1;

getCompletionResultsOrBuilderList

List<? extends CompleteQueryResponse.CompletionResultOrBuilder> getCompletionResultsOrBuilderList()

 Results of the matching suggestions. The result list is ordered and the
 first result is top suggestion.
 

repeated .google.cloud.retail.v2beta.CompleteQueryResponse.CompletionResult completion_results = 1;

getCompletionResultsOrBuilder

CompleteQueryResponse.CompletionResultOrBuilder getCompletionResultsOrBuilder(int index)

 Results of the matching suggestions. The result list is ordered and the
 first result is top suggestion.
 

repeated .google.cloud.retail.v2beta.CompleteQueryResponse.CompletionResult completion_results = 1;

getAttributionToken

String getAttributionToken()

 A unique complete token. This should be included in the
 [UserEvent.completion_detail][google.cloud.retail.v2beta.UserEvent.completion_detail]
 for search events resulting from this completion, which enables accurate
 attribution of complete model performance.
 

string attribution_token = 2;

Returns:

The attributionToken.

getAttributionTokenBytes

com.google.protobuf.ByteString getAttributionTokenBytes()

 A unique complete token. This should be included in the
 [UserEvent.completion_detail][google.cloud.retail.v2beta.UserEvent.completion_detail]
 for search events resulting from this completion, which enables accurate
 attribution of complete model performance.
 

string attribution_token = 2;

Returns:

The bytes for attributionToken.

getRecentSearchResultsList

List<CompleteQueryResponse.RecentSearchResult> getRecentSearchResultsList()

 Matched recent searches of this user. The maximum number of recent searches
 is 10. This field is a restricted feature. Contact Retail Search support
 team if you are interested in enabling it.

 This feature is only available when
 [CompleteQueryRequest.visitor_id][google.cloud.retail.v2beta.CompleteQueryRequest.visitor_id]
 field is set and [UserEvent][google.cloud.retail.v2beta.UserEvent] is
 imported. The recent searches satisfy the follow rules:

  * They are ordered from latest to oldest.

  * They are matched with
  [CompleteQueryRequest.query][google.cloud.retail.v2beta.CompleteQueryRequest.query]
  case insensitively.

  * They are transformed to lower case.

  * They are UTF-8 safe.

 Recent searches are deduplicated. More recent searches will be reserved
 when duplication happens.
 

repeated .google.cloud.retail.v2beta.CompleteQueryResponse.RecentSearchResult recent_search_results = 3;

getRecentSearchResults

CompleteQueryResponse.RecentSearchResult getRecentSearchResults(int index)

 Matched recent searches of this user. The maximum number of recent searches
 is 10. This field is a restricted feature. Contact Retail Search support
 team if you are interested in enabling it.

 This feature is only available when
 [CompleteQueryRequest.visitor_id][google.cloud.retail.v2beta.CompleteQueryRequest.visitor_id]
 field is set and [UserEvent][google.cloud.retail.v2beta.UserEvent] is
 imported. The recent searches satisfy the follow rules:

  * They are ordered from latest to oldest.

  * They are matched with
  [CompleteQueryRequest.query][google.cloud.retail.v2beta.CompleteQueryRequest.query]
  case insensitively.

  * They are transformed to lower case.

  * They are UTF-8 safe.

 Recent searches are deduplicated. More recent searches will be reserved
 when duplication happens.
 

repeated .google.cloud.retail.v2beta.CompleteQueryResponse.RecentSearchResult recent_search_results = 3;

getRecentSearchResultsCount

int getRecentSearchResultsCount()

 Matched recent searches of this user. The maximum number of recent searches
 is 10. This field is a restricted feature. Contact Retail Search support
 team if you are interested in enabling it.

 This feature is only available when
 [CompleteQueryRequest.visitor_id][google.cloud.retail.v2beta.CompleteQueryRequest.visitor_id]
 field is set and [UserEvent][google.cloud.retail.v2beta.UserEvent] is
 imported. The recent searches satisfy the follow rules:

  * They are ordered from latest to oldest.

  * They are matched with
  [CompleteQueryRequest.query][google.cloud.retail.v2beta.CompleteQueryRequest.query]
  case insensitively.

  * They are transformed to lower case.

  * They are UTF-8 safe.

 Recent searches are deduplicated. More recent searches will be reserved
 when duplication happens.
 

repeated .google.cloud.retail.v2beta.CompleteQueryResponse.RecentSearchResult recent_search_results = 3;

getRecentSearchResultsOrBuilderList

List<? extends CompleteQueryResponse.RecentSearchResultOrBuilder> getRecentSearchResultsOrBuilderList()

 Matched recent searches of this user. The maximum number of recent searches
 is 10. This field is a restricted feature. Contact Retail Search support
 team if you are interested in enabling it.

 This feature is only available when
 [CompleteQueryRequest.visitor_id][google.cloud.retail.v2beta.CompleteQueryRequest.visitor_id]
 field is set and [UserEvent][google.cloud.retail.v2beta.UserEvent] is
 imported. The recent searches satisfy the follow rules:

  * They are ordered from latest to oldest.

  * They are matched with
  [CompleteQueryRequest.query][google.cloud.retail.v2beta.CompleteQueryRequest.query]
  case insensitively.

  * They are transformed to lower case.

  * They are UTF-8 safe.

 Recent searches are deduplicated. More recent searches will be reserved
 when duplication happens.
 

repeated .google.cloud.retail.v2beta.CompleteQueryResponse.RecentSearchResult recent_search_results = 3;

getRecentSearchResultsOrBuilder

CompleteQueryResponse.RecentSearchResultOrBuilder getRecentSearchResultsOrBuilder(int index)

 Matched recent searches of this user. The maximum number of recent searches
 is 10. This field is a restricted feature. Contact Retail Search support
 team if you are interested in enabling it.

 This feature is only available when
 [CompleteQueryRequest.visitor_id][google.cloud.retail.v2beta.CompleteQueryRequest.visitor_id]
 field is set and [UserEvent][google.cloud.retail.v2beta.UserEvent] is
 imported. The recent searches satisfy the follow rules:

  * They are ordered from latest to oldest.

  * They are matched with
  [CompleteQueryRequest.query][google.cloud.retail.v2beta.CompleteQueryRequest.query]
  case insensitively.

  * They are transformed to lower case.

  * They are UTF-8 safe.

 Recent searches are deduplicated. More recent searches will be reserved
 when duplication happens.
 

repeated .google.cloud.retail.v2beta.CompleteQueryResponse.RecentSearchResult recent_search_results = 3;