Class Rule.FilterAction.Builder (2.44.0)

public static final class Rule.FilterAction.Builder extends GeneratedMessageV3.Builder<Rule.FilterAction.Builder> implements Rule.FilterActionOrBuilder
  • 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.

Protobuf type google.cloud.retail.v2.Rule.FilterAction

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Rule.FilterAction.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Rule.FilterAction.Builder
Overrides

build()

public Rule.FilterAction build()
Returns
Type Description
Rule.FilterAction

buildPartial()

public Rule.FilterAction buildPartial()
Returns
Type Description
Rule.FilterAction

clear()

public Rule.FilterAction.Builder clear()
Returns
Type Description
Rule.FilterAction.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public Rule.FilterAction.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Rule.FilterAction.Builder
Overrides

clearFilter()

public Rule.FilterAction.Builder clearFilter()

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":<br> (id: ANY("product_1", "product_2"))<br> AND<br> (colorFamilies: ANY("Red", "Blue"))<br>

string filter = 1;

Returns
Type Description
Rule.FilterAction.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Rule.FilterAction.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Rule.FilterAction.Builder
Overrides

clone()

public Rule.FilterAction.Builder clone()
Returns
Type Description
Rule.FilterAction.Builder
Overrides

getDefaultInstanceForType()

public Rule.FilterAction getDefaultInstanceForType()
Returns
Type Description
Rule.FilterAction

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFilter()

public String getFilter()

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":<br> (id: ANY("product_1", "product_2"))<br> AND<br> (colorFamilies: ANY("Red", "Blue"))<br>

string filter = 1;

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

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":<br> (id: ANY("product_1", "product_2"))<br> AND<br> (colorFamilies: ANY("Red", "Blue"))<br>

string filter = 1;

Returns
Type Description
ByteString

The bytes for filter.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Rule.FilterAction other)

public Rule.FilterAction.Builder mergeFrom(Rule.FilterAction other)
Parameter
Name Description
other Rule.FilterAction
Returns
Type Description
Rule.FilterAction.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Rule.FilterAction.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Rule.FilterAction.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Rule.FilterAction.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Rule.FilterAction.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Rule.FilterAction.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Rule.FilterAction.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public Rule.FilterAction.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Rule.FilterAction.Builder
Overrides

setFilter(String value)

public Rule.FilterAction.Builder setFilter(String value)

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":<br> (id: ANY("product_1", "product_2"))<br> AND<br> (colorFamilies: ANY("Red", "Blue"))<br>

string filter = 1;

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
Rule.FilterAction.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public Rule.FilterAction.Builder setFilterBytes(ByteString value)

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":<br> (id: ANY("product_1", "product_2"))<br> AND<br> (colorFamilies: ANY("Red", "Blue"))<br>

string filter = 1;

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
Rule.FilterAction.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Rule.FilterAction.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Rule.FilterAction.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Rule.FilterAction.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Rule.FilterAction.Builder
Overrides