- 2.55.0 (latest)
- 2.54.0
- 2.53.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.1
- 2.4.0
- 2.3.0
- 2.2.3
- 2.1.0
- 2.0.19
public static final class Rule.FilterAction.Builder extends GeneratedMessageV3.Builder<Rule.FilterAction.Builder> implements Rule.FilterActionOrBuilderRule 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Rule.FilterAction.BuilderImplements
Rule.FilterActionOrBuilderStatic 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 |
|
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 |
|
clearField(Descriptors.FieldDescriptor field)
public Rule.FilterAction.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Rule.FilterAction.Builder |
|
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. For more information, see Filter.
- 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 |
|
clone()
public Rule.FilterAction.Builder clone()| Returns | |
|---|---|
| Type | Description |
Rule.FilterAction.Builder |
|
getDefaultInstanceForType()
public Rule.FilterAction getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Rule.FilterAction |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. For more information, see Filter.
- 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. For more information, see Filter.
- 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 |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
| 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 |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Rule.FilterAction.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Rule.FilterAction.Builder |
|
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 |
|
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. For more information, see Filter.
- 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 |
StringThe 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. For more information, see Filter.
- 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 |
ByteStringThe 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 |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final Rule.FilterAction.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Rule.FilterAction.Builder |
|