Class Rule.FilterAction (2.31.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

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Rule.FilterAction getDefaultInstance()
Returns
TypeDescription
Rule.FilterAction

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Rule.FilterAction.Builder newBuilder()
Returns
TypeDescription
Rule.FilterAction.Builder

newBuilder(Rule.FilterAction prototype)

public static Rule.FilterAction.Builder newBuilder(Rule.FilterAction prototype)
Parameter
NameDescription
prototypeRule.FilterAction
Returns
TypeDescription
Rule.FilterAction.Builder

parseDelimitedFrom(InputStream input)

public static Rule.FilterAction parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Rule.FilterAction
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Rule.FilterAction parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Rule.FilterAction
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Rule.FilterAction parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Rule.FilterAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Rule.FilterAction parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Rule.FilterAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Rule.FilterAction parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Rule.FilterAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Rule.FilterAction parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Rule.FilterAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Rule.FilterAction parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Rule.FilterAction
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Rule.FilterAction parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Rule.FilterAction
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Rule.FilterAction parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Rule.FilterAction
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Rule.FilterAction parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Rule.FilterAction
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Rule.FilterAction parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Rule.FilterAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Rule.FilterAction parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Rule.FilterAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public Rule.FilterAction getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for filter.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Rule.FilterAction.Builder newBuilderForType()
Returns
TypeDescription
Rule.FilterAction.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Rule.FilterAction.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Rule.FilterAction.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Rule.FilterAction.Builder toBuilder()
Returns
TypeDescription
Rule.FilterAction.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException