Class: Google::Cloud::Retail::V2::Rule::FilterAction

Inherits:

Object

• Object
• Google::Cloud::Retail::V2::Rule::FilterAction

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/retail/v2/common.rb

Overview

• Rule Condition:

  • No Condition.query_terms provided is a global match.
  • 1 or more Condition.query_terms provided are combined with OR operator.

• Action Input: The request query and filter that are applied to the retrieved products, in addition to any filters already provided with the SearchRequest. The AND operator is used to combine the query's existing filters with the filter rule(s). NOTE: May result in 0 results when filters conflict.

• Action Result: Filters the returned objects to be ONLY those that passed the filter.

Instance Attribute Summary

• #filter ⇒ ::String

  A filter to apply on the matching condition results.

Instance Attribute Details

#filter ⇒ ::String

Returns A filter to apply on the matching condition results. Supported features:

• filter must be set.
• Filter syntax is identical to SearchRequest.filter. For more information, see Filter.
• To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue":
  (id: ANY("product_1", "product_2"))
  AND
  (colorFamilies: ANY("Red", "Blue"))
  .

Returns:

• (::String) —

  A filter to apply on the matching condition results. Supported features:

  • filter must be set.
  • Filter syntax is identical to SearchRequest.filter. For more information, see Filter.
  • To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue":
    (id: ANY("product_1", "product_2"))
    AND
    (colorFamilies: ANY("Red", "Blue"))
    

# File 'proto_docs/google/cloud/retail/v2/common.rb', line 198

class FilterAction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end