Class Rule.FilterAction (2.47.0) 

public static final class Rule.FilterAction extends GeneratedMessageV3 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.v2beta.Rule.FilterAction

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Rule.FilterAction

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Rule.FilterAction getDefaultInstance()
Returns
Type Description
Rule.FilterAction

getDescriptor()

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

newBuilder()

public static Rule.FilterAction.Builder newBuilder()
Returns
Type Description
Rule.FilterAction.Builder

newBuilder(Rule.FilterAction prototype)

public static Rule.FilterAction.Builder newBuilder(Rule.FilterAction prototype)
Parameter
Name Description
prototype Rule.FilterAction
Returns
Type Description
Rule.FilterAction.Builder

parseDelimitedFrom(InputStream input)

public static Rule.FilterAction parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Rule.FilterAction
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Rule.FilterAction parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Rule.FilterAction
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Rule.FilterAction parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Rule.FilterAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Rule.FilterAction parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Rule.FilterAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Rule.FilterAction parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Rule.FilterAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Rule.FilterAction parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Rule.FilterAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Rule.FilterAction parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Rule.FilterAction
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Rule.FilterAction parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Rule.FilterAction
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Rule.FilterAction parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Rule.FilterAction
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Rule.FilterAction parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Rule.FilterAction
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Rule.FilterAction parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Rule.FilterAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Rule.FilterAction parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Rule.FilterAction
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Rule.FilterAction> parser()
Returns
Type Description
Parser<FilterAction>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

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

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.

getParserForType()

public Parser<Rule.FilterAction> getParserForType()
Returns
Type Description
Parser<FilterAction>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Rule.FilterAction.Builder newBuilderForType()
Returns
Type Description
Rule.FilterAction.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Rule.FilterAction.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Rule.FilterAction.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Rule.FilterAction.Builder toBuilder()
Returns
Type Description
Rule.FilterAction.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException