Retail v2 API - Class Rule.Types.FilterAction (2.8.0) 

public sealed class Rule.Types.FilterAction : IMessage<Rule.Types.FilterAction>, IEquatable<Rule.Types.FilterAction>, IDeepCloneable<Rule.Types.FilterAction>, IBufferMessage, IMessage

Reference documentation and code samples for the Retail v2 API class Rule.Types.FilterAction.

  • Rule Condition:
    • No [Condition.query_terms][google.cloud.retail.v2.Condition.query_terms] provided is a global match.
    • 1 or more [Condition.query_terms][google.cloud.retail.v2.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.

Inheritance

object > Rule.Types.FilterAction

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

FilterAction()

public FilterAction()

FilterAction(FilterAction)

public FilterAction(Rule.Types.FilterAction other)
Parameter
Name Description
other RuleTypesFilterAction

Properties

Filter

public string Filter { get; set; }

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

  • [filter][google.cloud.retail.v2.Rule.FilterAction.filter] must be set.
  • Filter syntax is identical to [SearchRequest.filter][google.cloud.retail.v2.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":<br> (id: ANY("product_1", "product_2"))<br> AND<br> (colorFamilies: ANY("Red", "Blue"))<br>
Property Value
Type Description
string