Class: Google::Apis::RetailV2::GoogleCloudRetailV2RuleFilterAction

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/retail_v2/classes.rb,
lib/google/apis/retail_v2/representations.rb,
lib/google/apis/retail_v2/representations.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 collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2RuleFilterAction

Returns a new instance of GoogleCloudRetailV2RuleFilterAction.



3281
3282
3283
 
# File 'lib/google/apis/retail_v2/classes.rb', line 3281

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#filter ⇒ String

A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. See more details at the Retail Search user guide. * 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")) * Corresponds to the JSON property filter

Returns:

  • (String) 


3279
3280
3281
 
# File 'lib/google/apis/retail_v2/classes.rb', line 3279

def filter
  @filter
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3286
3287
3288
 
# File 'lib/google/apis/retail_v2/classes.rb', line 3286

def update!(**args)
  @filter = args[:filter] if args.key?(:filter)
end