Class Rule.FilterAction.Builder (2.13.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.v2alpha.Rule.FilterAction

Inheritance

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

Implements

Rule.FilterActionOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public Rule.FilterAction.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
`field`	`FieldDescriptor`

Returns

Type	Description
`Rule.FilterAction.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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

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

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clone()

public Rule.FilterAction.Builder clone()

Returns

Type	Description
`Rule.FilterAction.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public Rule.FilterAction getDefaultInstanceForType()

Returns

Type	Description
`Rule.FilterAction`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

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

string filter = 1;

Returns

Type	Description
`ByteString`	The bytes for filter.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Rule.FilterAction.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
`unknownFields`	`UnknownFieldSet`

Returns

Type	Description
`Rule.FilterAction.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final Rule.FilterAction.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
`unknownFields`	`UnknownFieldSet`

Returns

Type	Description
`Rule.FilterAction.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)