Package com.google.cloud.retail.v2alpha

Interface SearchResponseOrBuilder

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

  • Method Details

    • getResultsList

      List<SearchResponse.SearchResult> getResultsList()
       A list of matched items. The order represents the ranking.
      repeated .google.cloud.retail.v2alpha.SearchResponse.SearchResult results = 1;

    • getResults

      SearchResponse.SearchResult getResults(int index)
       A list of matched items. The order represents the ranking.
      repeated .google.cloud.retail.v2alpha.SearchResponse.SearchResult results = 1;

    • getResultsCount

      int getResultsCount()
       A list of matched items. The order represents the ranking.
      repeated .google.cloud.retail.v2alpha.SearchResponse.SearchResult results = 1;

    • getResultsOrBuilderList

      List<? extends SearchResponse.SearchResultOrBuilder> getResultsOrBuilderList()
       A list of matched items. The order represents the ranking.
      repeated .google.cloud.retail.v2alpha.SearchResponse.SearchResult results = 1;

    • getResultsOrBuilder

      SearchResponse.SearchResultOrBuilder getResultsOrBuilder(int index)
       A list of matched items. The order represents the ranking.
      repeated .google.cloud.retail.v2alpha.SearchResponse.SearchResult results = 1;

    • getFacetsList

      List<SearchResponse.Facet> getFacetsList()
       Results of facets requested by user.
      repeated .google.cloud.retail.v2alpha.SearchResponse.Facet facets = 2;

    • getFacets

      SearchResponse.Facet getFacets(int index)
       Results of facets requested by user.
      repeated .google.cloud.retail.v2alpha.SearchResponse.Facet facets = 2;

    • getFacetsCount

      int getFacetsCount()
       Results of facets requested by user.
      repeated .google.cloud.retail.v2alpha.SearchResponse.Facet facets = 2;

    • getFacetsOrBuilderList

      List<? extends SearchResponse.FacetOrBuilder> getFacetsOrBuilderList()
       Results of facets requested by user.
      repeated .google.cloud.retail.v2alpha.SearchResponse.Facet facets = 2;

    • getFacetsOrBuilder

      SearchResponse.FacetOrBuilder getFacetsOrBuilder(int index)
       Results of facets requested by user.
      repeated .google.cloud.retail.v2alpha.SearchResponse.Facet facets = 2;

    • getTotalSize

      int getTotalSize()
       The estimated total count of matched items irrespective of pagination. The
 count of [results][google.cloud.retail.v2alpha.SearchResponse.results]
 returned by pagination may be less than the
 [total_size][google.cloud.retail.v2alpha.SearchResponse.total_size] that
 matches.
      int32 total_size = 3;
      Returns:
      The totalSize.

    • getCorrectedQuery

      String getCorrectedQuery()
       Contains the spell corrected query, if found. If the spell correction type
 is AUTOMATIC, then the search results are based on corrected_query.
 Otherwise the original query is used for search.
      string corrected_query = 4;
      Returns:
      The correctedQuery.

    • getCorrectedQueryBytes

      com.google.protobuf.ByteString getCorrectedQueryBytes()
       Contains the spell corrected query, if found. If the spell correction type
 is AUTOMATIC, then the search results are based on corrected_query.
 Otherwise the original query is used for search.
      string corrected_query = 4;
      Returns:
      The bytes for correctedQuery.

    • getAttributionToken

      String getAttributionToken()
       A unique search token. This should be included in the
 [UserEvent][google.cloud.retail.v2alpha.UserEvent] logs resulting from this
 search, which enables accurate attribution of search model performance.
      string attribution_token = 5;
      Returns:
      The attributionToken.

    • getAttributionTokenBytes

      com.google.protobuf.ByteString getAttributionTokenBytes()
       A unique search token. This should be included in the
 [UserEvent][google.cloud.retail.v2alpha.UserEvent] logs resulting from this
 search, which enables accurate attribution of search model performance.
      string attribution_token = 5;
      Returns:
      The bytes for attributionToken.

    • getNextPageToken

      String getNextPageToken()
       A token that can be sent as
 [SearchRequest.page_token][google.cloud.retail.v2alpha.SearchRequest.page_token]
 to retrieve the next page. If this field is omitted, there are no
 subsequent pages.
      string next_page_token = 6;
      Returns:
      The nextPageToken.

    • getNextPageTokenBytes

      com.google.protobuf.ByteString getNextPageTokenBytes()
       A token that can be sent as
 [SearchRequest.page_token][google.cloud.retail.v2alpha.SearchRequest.page_token]
 to retrieve the next page. If this field is omitted, there are no
 subsequent pages.
      string next_page_token = 6;
      Returns:
      The bytes for nextPageToken.

    • hasQueryExpansionInfo

      boolean hasQueryExpansionInfo()
       Query expansion information for the returned results.
      .google.cloud.retail.v2alpha.SearchResponse.QueryExpansionInfo query_expansion_info = 7;
      Returns:
      Whether the queryExpansionInfo field is set.

    • getQueryExpansionInfo

      SearchResponse.QueryExpansionInfo getQueryExpansionInfo()
       Query expansion information for the returned results.
      .google.cloud.retail.v2alpha.SearchResponse.QueryExpansionInfo query_expansion_info = 7;
      Returns:
      The queryExpansionInfo.

    • getQueryExpansionInfoOrBuilder

      SearchResponse.QueryExpansionInfoOrBuilder getQueryExpansionInfoOrBuilder()
       Query expansion information for the returned results.
      .google.cloud.retail.v2alpha.SearchResponse.QueryExpansionInfo query_expansion_info = 7;

    • getRedirectUri

      String getRedirectUri()
       The URI of a customer-defined redirect page. If redirect action is
 triggered, no search is performed, and only
 [redirect_uri][google.cloud.retail.v2alpha.SearchResponse.redirect_uri] and
 [attribution_token][google.cloud.retail.v2alpha.SearchResponse.attribution_token]
 are set in the response.
      string redirect_uri = 10;
      Returns:
      The redirectUri.

    • getRedirectUriBytes

      com.google.protobuf.ByteString getRedirectUriBytes()
       The URI of a customer-defined redirect page. If redirect action is
 triggered, no search is performed, and only
 [redirect_uri][google.cloud.retail.v2alpha.SearchResponse.redirect_uri] and
 [attribution_token][google.cloud.retail.v2alpha.SearchResponse.attribution_token]
 are set in the response.
      string redirect_uri = 10;
      Returns:
      The bytes for redirectUri.

    • getAppliedControlsList

      List<String> getAppliedControlsList()
       The fully qualified resource name of applied
 [controls](https://cloud.google.com/retail/docs/serving-control-rules).
      repeated string applied_controls = 12;
      Returns:
      A list containing the appliedControls.

    • getAppliedControlsCount

      int getAppliedControlsCount()
       The fully qualified resource name of applied
 [controls](https://cloud.google.com/retail/docs/serving-control-rules).
      repeated string applied_controls = 12;
      Returns:
      The count of appliedControls.

    • getAppliedControls

      String getAppliedControls(int index)
       The fully qualified resource name of applied
 [controls](https://cloud.google.com/retail/docs/serving-control-rules).
      repeated string applied_controls = 12;
      Parameters:
      index - The index of the element to return.
      Returns:
      The appliedControls at the given index.

    • getAppliedControlsBytes

      com.google.protobuf.ByteString getAppliedControlsBytes(int index)
       The fully qualified resource name of applied
 [controls](https://cloud.google.com/retail/docs/serving-control-rules).
      repeated string applied_controls = 12;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the appliedControls at the given index.

    • hasPinControlMetadata

      boolean hasPinControlMetadata()
       Metadata for pin controls which were applicable to the request.
 This contains two map fields, one for all matched pins and one for pins
 which were matched but not applied.

 The two maps are keyed by pin position, and the values are the product ids
 which were matched to that pin.
      .google.cloud.retail.v2alpha.PinControlMetadata pin_control_metadata = 22;
      Returns:
      Whether the pinControlMetadata field is set.

    • getPinControlMetadata

      PinControlMetadata getPinControlMetadata()
       Metadata for pin controls which were applicable to the request.
 This contains two map fields, one for all matched pins and one for pins
 which were matched but not applied.

 The two maps are keyed by pin position, and the values are the product ids
 which were matched to that pin.
      .google.cloud.retail.v2alpha.PinControlMetadata pin_control_metadata = 22;
      Returns:
      The pinControlMetadata.

    • getPinControlMetadataOrBuilder

      PinControlMetadataOrBuilder getPinControlMetadataOrBuilder()
       Metadata for pin controls which were applicable to the request.
 This contains two map fields, one for all matched pins and one for pins
 which were matched but not applied.

 The two maps are keyed by pin position, and the values are the product ids
 which were matched to that pin.
      .google.cloud.retail.v2alpha.PinControlMetadata pin_control_metadata = 22;

    • getInvalidConditionBoostSpecsList

      List<SearchRequest.BoostSpec.ConditionBoostSpec> getInvalidConditionBoostSpecsList()
       The invalid
 [SearchRequest.BoostSpec.condition_boost_specs][google.cloud.retail.v2alpha.SearchRequest.BoostSpec.condition_boost_specs]
 that are not applied during serving.
      repeated .google.cloud.retail.v2alpha.SearchRequest.BoostSpec.ConditionBoostSpec invalid_condition_boost_specs = 14;

    • getInvalidConditionBoostSpecs

      SearchRequest.BoostSpec.ConditionBoostSpec getInvalidConditionBoostSpecs(int index)
       The invalid
 [SearchRequest.BoostSpec.condition_boost_specs][google.cloud.retail.v2alpha.SearchRequest.BoostSpec.condition_boost_specs]
 that are not applied during serving.
      repeated .google.cloud.retail.v2alpha.SearchRequest.BoostSpec.ConditionBoostSpec invalid_condition_boost_specs = 14;

    • getInvalidConditionBoostSpecsCount

      int getInvalidConditionBoostSpecsCount()
       The invalid
 [SearchRequest.BoostSpec.condition_boost_specs][google.cloud.retail.v2alpha.SearchRequest.BoostSpec.condition_boost_specs]
 that are not applied during serving.
      repeated .google.cloud.retail.v2alpha.SearchRequest.BoostSpec.ConditionBoostSpec invalid_condition_boost_specs = 14;

    • getInvalidConditionBoostSpecsOrBuilderList

      List<? extends SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder> getInvalidConditionBoostSpecsOrBuilderList()
       The invalid
 [SearchRequest.BoostSpec.condition_boost_specs][google.cloud.retail.v2alpha.SearchRequest.BoostSpec.condition_boost_specs]
 that are not applied during serving.
      repeated .google.cloud.retail.v2alpha.SearchRequest.BoostSpec.ConditionBoostSpec invalid_condition_boost_specs = 14;

    • getInvalidConditionBoostSpecsOrBuilder

      SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder getInvalidConditionBoostSpecsOrBuilder(int index)
       The invalid
 [SearchRequest.BoostSpec.condition_boost_specs][google.cloud.retail.v2alpha.SearchRequest.BoostSpec.condition_boost_specs]
 that are not applied during serving.
      repeated .google.cloud.retail.v2alpha.SearchRequest.BoostSpec.ConditionBoostSpec invalid_condition_boost_specs = 14;

    • getExperimentInfoList

      List<ExperimentInfo> getExperimentInfoList()
       Metadata related to A/B testing experiment associated with this
 response. Only exists when an experiment is triggered.
      repeated .google.cloud.retail.v2alpha.ExperimentInfo experiment_info = 17;

    • getExperimentInfo

      ExperimentInfo getExperimentInfo(int index)
       Metadata related to A/B testing experiment associated with this
 response. Only exists when an experiment is triggered.
      repeated .google.cloud.retail.v2alpha.ExperimentInfo experiment_info = 17;

    • getExperimentInfoCount

      int getExperimentInfoCount()
       Metadata related to A/B testing experiment associated with this
 response. Only exists when an experiment is triggered.
      repeated .google.cloud.retail.v2alpha.ExperimentInfo experiment_info = 17;

    • getExperimentInfoOrBuilderList

      List<? extends ExperimentInfoOrBuilder> getExperimentInfoOrBuilderList()
       Metadata related to A/B testing experiment associated with this
 response. Only exists when an experiment is triggered.
      repeated .google.cloud.retail.v2alpha.ExperimentInfo experiment_info = 17;

    • getExperimentInfoOrBuilder

      ExperimentInfoOrBuilder getExperimentInfoOrBuilder(int index)
       Metadata related to A/B testing experiment associated with this
 response. Only exists when an experiment is triggered.
      repeated .google.cloud.retail.v2alpha.ExperimentInfo experiment_info = 17;

    • hasConversationalSearchResult

      boolean hasConversationalSearchResult()
       This field specifies all related information that is needed on client
 side for UI rendering of conversational retail search.
      .google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult conversational_search_result = 18;
      Returns:
      Whether the conversationalSearchResult field is set.

    • getConversationalSearchResult

      SearchResponse.ConversationalSearchResult getConversationalSearchResult()
       This field specifies all related information that is needed on client
 side for UI rendering of conversational retail search.
      .google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult conversational_search_result = 18;
      Returns:
      The conversationalSearchResult.

    • getConversationalSearchResultOrBuilder

      SearchResponse.ConversationalSearchResultOrBuilder getConversationalSearchResultOrBuilder()
       This field specifies all related information that is needed on client
 side for UI rendering of conversational retail search.
      .google.cloud.retail.v2alpha.SearchResponse.ConversationalSearchResult conversational_search_result = 18;

    • hasTileNavigationResult

      boolean hasTileNavigationResult()
       This field specifies all related information for tile navigation that will
 be used in client side.
      .google.cloud.retail.v2alpha.SearchResponse.TileNavigationResult tile_navigation_result = 19;
      Returns:
      Whether the tileNavigationResult field is set.

    • getTileNavigationResult

      SearchResponse.TileNavigationResult getTileNavigationResult()
       This field specifies all related information for tile navigation that will
 be used in client side.
      .google.cloud.retail.v2alpha.SearchResponse.TileNavigationResult tile_navigation_result = 19;
      Returns:
      The tileNavigationResult.

    • getTileNavigationResultOrBuilder

      SearchResponse.TileNavigationResultOrBuilder getTileNavigationResultOrBuilder()
       This field specifies all related information for tile navigation that will
 be used in client side.
      .google.cloud.retail.v2alpha.SearchResponse.TileNavigationResult tile_navigation_result = 19;