Package com.google.cloud.retail.v2alpha

Interface ConversationalSearchRequest.SearchParamsOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ConversationalSearchRequest.SearchParams, ConversationalSearchRequest.SearchParams.Builder
Enclosing class:
ConversationalSearchRequest
public static interface ConversationalSearchRequest.SearchParamsOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getFilter

      String getFilter()
       Optional. The filter string to restrict search results.

 The syntax of the filter string is the same as
 [SearchRequest.filter][google.cloud.retail.v2alpha.SearchRequest.filter].
      string filter = 1 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The filter.

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       Optional. The filter string to restrict search results.

 The syntax of the filter string is the same as
 [SearchRequest.filter][google.cloud.retail.v2alpha.SearchRequest.filter].
      string filter = 1 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for filter.

    • getCanonicalFilter

      String getCanonicalFilter()
       Optional. The canonical filter string to restrict search results.

 The syntax of the canonical filter string is the same as
 [SearchRequest.canonical_filter][google.cloud.retail.v2alpha.SearchRequest.canonical_filter].
      string canonical_filter = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The canonicalFilter.

    • getCanonicalFilterBytes

      com.google.protobuf.ByteString getCanonicalFilterBytes()
       Optional. The canonical filter string to restrict search results.

 The syntax of the canonical filter string is the same as
 [SearchRequest.canonical_filter][google.cloud.retail.v2alpha.SearchRequest.canonical_filter].
      string canonical_filter = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for canonicalFilter.

    • getSortBy

      String getSortBy()
       Optional. The sort string to specify the sorting of search results.

 The syntax of the sort string is the same as
 [SearchRequest.sort][].
      string sort_by = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The sortBy.

    • getSortByBytes

      com.google.protobuf.ByteString getSortByBytes()
       Optional. The sort string to specify the sorting of search results.

 The syntax of the sort string is the same as
 [SearchRequest.sort][].
      string sort_by = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for sortBy.

    • hasBoostSpec

      boolean hasBoostSpec()
       Optional. The boost spec to specify the boosting of search results.

 The syntax of the boost spec is the same as
 [SearchRequest.boost_spec][google.cloud.retail.v2alpha.SearchRequest.boost_spec].
      .google.cloud.retail.v2alpha.SearchRequest.BoostSpec boost_spec = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the boostSpec field is set.

    • getBoostSpec

      SearchRequest.BoostSpec getBoostSpec()
       Optional. The boost spec to specify the boosting of search results.

 The syntax of the boost spec is the same as
 [SearchRequest.boost_spec][google.cloud.retail.v2alpha.SearchRequest.boost_spec].
      .google.cloud.retail.v2alpha.SearchRequest.BoostSpec boost_spec = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The boostSpec.

    • getBoostSpecOrBuilder

      SearchRequest.BoostSpecOrBuilder getBoostSpecOrBuilder()
       Optional. The boost spec to specify the boosting of search results.

 The syntax of the boost spec is the same as
 [SearchRequest.boost_spec][google.cloud.retail.v2alpha.SearchRequest.boost_spec].
      .google.cloud.retail.v2alpha.SearchRequest.BoostSpec boost_spec = 4 [(.google.api.field_behavior) = OPTIONAL];