Package com.google.cloud.retail.v2alpha

Interface CompleteQueryResponseOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
CompleteQueryResponse, CompleteQueryResponse.Builder
@Generated public interface CompleteQueryResponseOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • 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.v2alpha.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.v2alpha.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.v2alpha.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.v2alpha.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.v2alpha.CompleteQueryResponse.CompletionResult completion_results = 1;

    • getAttributionToken

      String getAttributionToken()
       A unique complete token. This should be included in the
 [UserEvent.completion_detail][google.cloud.retail.v2alpha.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.v2alpha.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

      @Deprecated List<CompleteQueryResponse.RecentSearchResult> getRecentSearchResultsList()
      Deprecated.
       Deprecated. Matched recent searches of this user. The maximum number of
 recent searches is 10. This field is a restricted feature. If you want to
 enable it, contact Retail Search support.

 This feature is only available when
 [CompleteQueryRequest.visitor_id][google.cloud.retail.v2alpha.CompleteQueryRequest.visitor_id]
 field is set and [UserEvent][google.cloud.retail.v2alpha.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.v2alpha.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.v2alpha.CompleteQueryResponse.RecentSearchResult recent_search_results = 3 [deprecated = true];

    • getRecentSearchResults

      @Deprecated CompleteQueryResponse.RecentSearchResult getRecentSearchResults(int index)
      Deprecated.
       Deprecated. Matched recent searches of this user. The maximum number of
 recent searches is 10. This field is a restricted feature. If you want to
 enable it, contact Retail Search support.

 This feature is only available when
 [CompleteQueryRequest.visitor_id][google.cloud.retail.v2alpha.CompleteQueryRequest.visitor_id]
 field is set and [UserEvent][google.cloud.retail.v2alpha.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.v2alpha.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.v2alpha.CompleteQueryResponse.RecentSearchResult recent_search_results = 3 [deprecated = true];

    • getRecentSearchResultsCount

      @Deprecated int getRecentSearchResultsCount()
      Deprecated.
       Deprecated. Matched recent searches of this user. The maximum number of
 recent searches is 10. This field is a restricted feature. If you want to
 enable it, contact Retail Search support.

 This feature is only available when
 [CompleteQueryRequest.visitor_id][google.cloud.retail.v2alpha.CompleteQueryRequest.visitor_id]
 field is set and [UserEvent][google.cloud.retail.v2alpha.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.v2alpha.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.v2alpha.CompleteQueryResponse.RecentSearchResult recent_search_results = 3 [deprecated = true];

    • getRecentSearchResultsOrBuilderList

      @Deprecated List<? extends CompleteQueryResponse.RecentSearchResultOrBuilder> getRecentSearchResultsOrBuilderList()
      Deprecated.
       Deprecated. Matched recent searches of this user. The maximum number of
 recent searches is 10. This field is a restricted feature. If you want to
 enable it, contact Retail Search support.

 This feature is only available when
 [CompleteQueryRequest.visitor_id][google.cloud.retail.v2alpha.CompleteQueryRequest.visitor_id]
 field is set and [UserEvent][google.cloud.retail.v2alpha.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.v2alpha.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.v2alpha.CompleteQueryResponse.RecentSearchResult recent_search_results = 3 [deprecated = true];

    • getRecentSearchResultsOrBuilder

      @Deprecated CompleteQueryResponse.RecentSearchResultOrBuilder getRecentSearchResultsOrBuilder(int index)
      Deprecated.
       Deprecated. Matched recent searches of this user. The maximum number of
 recent searches is 10. This field is a restricted feature. If you want to
 enable it, contact Retail Search support.

 This feature is only available when
 [CompleteQueryRequest.visitor_id][google.cloud.retail.v2alpha.CompleteQueryRequest.visitor_id]
 field is set and [UserEvent][google.cloud.retail.v2alpha.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.v2alpha.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.v2alpha.CompleteQueryResponse.RecentSearchResult recent_search_results = 3 [deprecated = true];

    • getAttributeResultsCount

      int getAttributeResultsCount()
       A map of matched attribute suggestions. This field is only available for
 `cloud-retail` dataset.

 Current supported keys:

 * `brands`

 * `categories`
      map<string, .google.cloud.retail.v2alpha.CompleteQueryResponse.AttributeResult> attribute_results = 4;

    • containsAttributeResults

      boolean containsAttributeResults(String key)
       A map of matched attribute suggestions. This field is only available for
 `cloud-retail` dataset.

 Current supported keys:

 * `brands`

 * `categories`
      map<string, .google.cloud.retail.v2alpha.CompleteQueryResponse.AttributeResult> attribute_results = 4;

    • getAttributeResults

      @Deprecated Map<String,CompleteQueryResponse.AttributeResult> getAttributeResults()
      Deprecated.
      Use getAttributeResultsMap() instead.

    • getAttributeResultsMap

      Map<String,CompleteQueryResponse.AttributeResult> getAttributeResultsMap()
       A map of matched attribute suggestions. This field is only available for
 `cloud-retail` dataset.

 Current supported keys:

 * `brands`

 * `categories`
      map<string, .google.cloud.retail.v2alpha.CompleteQueryResponse.AttributeResult> attribute_results = 4;

    • getAttributeResultsOrDefault

      CompleteQueryResponse.AttributeResult getAttributeResultsOrDefault(String key, CompleteQueryResponse.AttributeResult defaultValue)
       A map of matched attribute suggestions. This field is only available for
 `cloud-retail` dataset.

 Current supported keys:

 * `brands`

 * `categories`
      map<string, .google.cloud.retail.v2alpha.CompleteQueryResponse.AttributeResult> attribute_results = 4;

    • getAttributeResultsOrThrow

      CompleteQueryResponse.AttributeResult getAttributeResultsOrThrow(String key)
       A map of matched attribute suggestions. This field is only available for
 `cloud-retail` dataset.

 Current supported keys:

 * `brands`

 * `categories`
      map<string, .google.cloud.retail.v2alpha.CompleteQueryResponse.AttributeResult> attribute_results = 4;