- 2.80.0 (latest)
 - 2.78.0
 - 2.77.0
 - 2.76.0
 - 2.75.0
 - 2.74.0
 - 2.72.0
 - 2.70.0
 - 2.69.0
 - 2.66.0
 - 2.65.0
 - 2.64.0
 - 2.62.0
 - 2.61.0
 - 2.60.0
 - 2.59.0
 - 2.58.0
 - 2.57.0
 - 2.56.0
 - 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 interface CompleteQueryResponseOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAttributionToken()
public abstract String getAttributionToken()A unique complete token. This should be included in the UserEvent.completion_detail for search events resulting from this completion, which enables accurate attribution of complete model performance.
 string attribution_token = 2;
| Returns | |
|---|---|
| Type | Description | 
String | 
        The attributionToken.  | 
      
getAttributionTokenBytes()
public abstract ByteString getAttributionTokenBytes()A unique complete token. This should be included in the UserEvent.completion_detail for search events resulting from this completion, which enables accurate attribution of complete model performance.
 string attribution_token = 2;
| Returns | |
|---|---|
| Type | Description | 
ByteString | 
        The bytes for attributionToken.  | 
      
getCompletionResults(int index)
public abstract 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.v2.CompleteQueryResponse.CompletionResult completion_results = 1;
 
| Parameter | |
|---|---|
| Name | Description | 
index | 
        int | 
      
| Returns | |
|---|---|
| Type | Description | 
CompleteQueryResponse.CompletionResult | 
        |
getCompletionResultsCount()
public abstract int getCompletionResultsCount()Results of the matching suggestions. The result list is ordered and the first result is top suggestion.
 
 repeated .google.cloud.retail.v2.CompleteQueryResponse.CompletionResult completion_results = 1;
 
| Returns | |
|---|---|
| Type | Description | 
int | 
        |
getCompletionResultsList()
public abstract 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.v2.CompleteQueryResponse.CompletionResult completion_results = 1;
 
| Returns | |
|---|---|
| Type | Description | 
List<CompletionResult> | 
        |
getCompletionResultsOrBuilder(int index)
public abstract 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.v2.CompleteQueryResponse.CompletionResult completion_results = 1;
 
| Parameter | |
|---|---|
| Name | Description | 
index | 
        int | 
      
| Returns | |
|---|---|
| Type | Description | 
CompleteQueryResponse.CompletionResultOrBuilder | 
        |
getCompletionResultsOrBuilderList()
public abstract 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.v2.CompleteQueryResponse.CompletionResult completion_results = 1;
 
| Returns | |
|---|---|
| Type | Description | 
List<? extends com.google.cloud.retail.v2.CompleteQueryResponse.CompletionResultOrBuilder> | 
        |
getRecentSearchResults(int index)
public abstract 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 field is set and UserEvent is imported. The recent searches satisfy the follow rules:
They are ordered from latest to oldest.
They are matched with 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.v2.CompleteQueryResponse.RecentSearchResult recent_search_results = 3;
 
| Parameter | |
|---|---|
| Name | Description | 
index | 
        int | 
      
| Returns | |
|---|---|
| Type | Description | 
CompleteQueryResponse.RecentSearchResult | 
        |
getRecentSearchResultsCount()
public abstract 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 field is set and UserEvent is imported. The recent searches satisfy the follow rules:
They are ordered from latest to oldest.
They are matched with 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.v2.CompleteQueryResponse.RecentSearchResult recent_search_results = 3;
 
| Returns | |
|---|---|
| Type | Description | 
int | 
        |
getRecentSearchResultsList()
public abstract 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 field is set and UserEvent is imported. The recent searches satisfy the follow rules:
They are ordered from latest to oldest.
They are matched with 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.v2.CompleteQueryResponse.RecentSearchResult recent_search_results = 3;
 
| Returns | |
|---|---|
| Type | Description | 
List<RecentSearchResult> | 
        |
getRecentSearchResultsOrBuilder(int index)
public abstract 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 field is set and UserEvent is imported. The recent searches satisfy the follow rules:
They are ordered from latest to oldest.
They are matched with 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.v2.CompleteQueryResponse.RecentSearchResult recent_search_results = 3;
 
| Parameter | |
|---|---|
| Name | Description | 
index | 
        int | 
      
| Returns | |
|---|---|
| Type | Description | 
CompleteQueryResponse.RecentSearchResultOrBuilder | 
        |
getRecentSearchResultsOrBuilderList()
public abstract 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 field is set and UserEvent is imported. The recent searches satisfy the follow rules:
They are ordered from latest to oldest.
They are matched with 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.v2.CompleteQueryResponse.RecentSearchResult recent_search_results = 3;
 
| Returns | |
|---|---|
| Type | Description | 
List<? extends com.google.cloud.retail.v2.CompleteQueryResponse.RecentSearchResultOrBuilder> | 
        |