Package com.google.cloud.retail.v2alpha

Interface Rule.FilterActionOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Rule.FilterAction, Rule.FilterAction.Builder
Enclosing class:
Rule
public static interface Rule.FilterActionOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFilter()
    A filter to apply on the matching condition results.
    com.google.protobuf.ByteString
    getFilterBytes()
    A filter to apply on the matching condition results.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getFilter

      String getFilter()
       A filter to apply on the matching condition results. Supported features:

 * [filter][google.cloud.retail.v2alpha.Rule.FilterAction.filter] must be
 set.
 * Filter syntax is identical to
 [SearchRequest.filter][google.cloud.retail.v2alpha.SearchRequest.filter].
 For more
 information, see [Filter](/retail/docs/filter-and-order#filter).
 * To filter products with product ID "product_1" or "product_2", and
 color
 "Red" or "Blue":<br>
 *(id: ANY("product_1", "product_2"))<br>*
 *AND<br>*
 *(colorFamilies: ANY("Red", "Blue"))<br>*
      string filter = 1;
      Returns:
      The filter.

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       A filter to apply on the matching condition results. Supported features:

 * [filter][google.cloud.retail.v2alpha.Rule.FilterAction.filter] must be
 set.
 * Filter syntax is identical to
 [SearchRequest.filter][google.cloud.retail.v2alpha.SearchRequest.filter].
 For more
 information, see [Filter](/retail/docs/filter-and-order#filter).
 * To filter products with product ID "product_1" or "product_2", and
 color
 "Red" or "Blue":<br>
 *(id: ANY("product_1", "product_2"))<br>*
 *AND<br>*
 *(colorFamilies: ANY("Red", "Blue"))<br>*
      string filter = 1;
      Returns:
      The bytes for filter.