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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Rule.FilterAction.Builder newBuilder()
newBuilder(Rule.FilterAction prototype)
public static Rule.FilterAction.Builder newBuilder(Rule.FilterAction prototype)
public static Rule.FilterAction parseDelimitedFrom(InputStream input)
public static Rule.FilterAction parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Rule.FilterAction parseFrom(byte[] data)
Parameter |
---|
Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Rule.FilterAction parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Rule.FilterAction parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Rule.FilterAction parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Rule.FilterAction parseFrom(CodedInputStream input)
public static Rule.FilterAction parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Rule.FilterAction parseFrom(InputStream input)
public static Rule.FilterAction parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Rule.FilterAction parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Rule.FilterAction parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Rule.FilterAction> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter |
---|
Name | Description |
obj | Object
|
Overrides
getDefaultInstanceForType()
public Rule.FilterAction getDefaultInstanceForType()
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()
Overrides
getSerializedSize()
public int getSerializedSize()
Returns |
---|
Type | Description |
int | |
Overrides
hashCode()
Returns |
---|
Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Rule.FilterAction.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Rule.FilterAction.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Rule.FilterAction.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides