Package com.google.cloud.retail.v2alpha

Interface CompleteQueryResponse.CompletionResultOrBuilder

    • 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;

      • 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. Please reach out
 to the support team if you would like to receive this information.
        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. Please reach out
 to the support team if you would like to receive this information.
        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. Please reach out
 to the support team if you would like to receive this information.
        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. Please reach out
 to the support team if you would like to receive this information.
        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. Please reach out
 to the support team if you would like to receive this information.
        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. Please reach out
 to the support team if you would like to receive this information.
        int32 total_product_count = 4;
        Returns:
        The totalProductCount.