Package com.google.cloud.retail.v2beta

Class Rule.FilterAction.Builder

  • All Implemented Interfaces:
    Rule.FilterActionOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    Rule.FilterAction
    public static final class Rule.FilterAction.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Rule.FilterAction.Builder>
implements Rule.FilterActionOrBuilder
     * Rule Condition:
   - No
   [Condition.query_terms][google.cloud.retail.v2beta.Condition.query_terms]
   provided is a global match.
   - 1 or more
   [Condition.query_terms][google.cloud.retail.v2beta.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

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Rule.FilterAction.Builder>

      • clear

        public Rule.FilterAction.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<Rule.FilterAction.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Rule.FilterAction.Builder>

      • getDefaultInstanceForType

        public Rule.FilterAction getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public Rule.FilterAction build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public Rule.FilterAction buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public Rule.FilterAction.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<Rule.FilterAction.Builder>

      • setField

        public Rule.FilterAction.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<Rule.FilterAction.Builder>

      • clearField

        public Rule.FilterAction.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Rule.FilterAction.Builder>

      • clearOneof

        public Rule.FilterAction.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Rule.FilterAction.Builder>

      • setRepeatedField

        public Rule.FilterAction.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  int index,
                                                  Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Rule.FilterAction.Builder>

      • addRepeatedField

        public Rule.FilterAction.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Rule.FilterAction.Builder>

      • mergeFrom

        public Rule.FilterAction.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Rule.FilterAction.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Rule.FilterAction.Builder>

      • mergeFrom

        public Rule.FilterAction.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Rule.FilterAction.Builder>
        Throws:
        IOException

      • getFilter

        public String getFilter()
         A filter to apply on the matching condition results. Supported features:

 * [filter][google.cloud.retail.v2beta.Rule.FilterAction.filter] must be
 set.
 * Filter syntax is identical to
 [SearchRequest.filter][google.cloud.retail.v2beta.SearchRequest.filter].
 See more
   details at the Retail Search
   [user guide](/retail/search/docs/filter-and-order#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;
        Specified by:
        getFilter in interface Rule.FilterActionOrBuilder
        Returns:
        The filter.

      • getFilterBytes

        public com.google.protobuf.ByteString getFilterBytes()
         A filter to apply on the matching condition results. Supported features:

 * [filter][google.cloud.retail.v2beta.Rule.FilterAction.filter] must be
 set.
 * Filter syntax is identical to
 [SearchRequest.filter][google.cloud.retail.v2beta.SearchRequest.filter].
 See more
   details at the Retail Search
   [user guide](/retail/search/docs/filter-and-order#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;
        Specified by:
        getFilterBytes in interface Rule.FilterActionOrBuilder
        Returns:
        The bytes for filter.

      • setFilter

        public Rule.FilterAction.Builder setFilter​(String value)
         A filter to apply on the matching condition results. Supported features:

 * [filter][google.cloud.retail.v2beta.Rule.FilterAction.filter] must be
 set.
 * Filter syntax is identical to
 [SearchRequest.filter][google.cloud.retail.v2beta.SearchRequest.filter].
 See more
   details at the Retail Search
   [user guide](/retail/search/docs/filter-and-order#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;
        Parameters:
        value - The filter to set.
        Returns:
        This builder for chaining.

      • clearFilter

        public Rule.FilterAction.Builder clearFilter()
         A filter to apply on the matching condition results. Supported features:

 * [filter][google.cloud.retail.v2beta.Rule.FilterAction.filter] must be
 set.
 * Filter syntax is identical to
 [SearchRequest.filter][google.cloud.retail.v2beta.SearchRequest.filter].
 See more
   details at the Retail Search
   [user guide](/retail/search/docs/filter-and-order#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:
        This builder for chaining.

      • setFilterBytes

        public Rule.FilterAction.Builder setFilterBytes​(com.google.protobuf.ByteString value)
         A filter to apply on the matching condition results. Supported features:

 * [filter][google.cloud.retail.v2beta.Rule.FilterAction.filter] must be
 set.
 * Filter syntax is identical to
 [SearchRequest.filter][google.cloud.retail.v2beta.SearchRequest.filter].
 See more
   details at the Retail Search
   [user guide](/retail/search/docs/filter-and-order#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;
        Parameters:
        value - The bytes for filter to set.
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final Rule.FilterAction.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Rule.FilterAction.Builder>

      • mergeUnknownFields

        public final Rule.FilterAction.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Rule.FilterAction.Builder>