Package com.google.cloud.retail.v2alpha

Class Rule.FilterAction.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Rule.FilterAction.Builder>
com.google.cloud.retail.v2alpha.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.GeneratedMessage.Builder<Rule.FilterAction.Builder> implements Rule.FilterActionOrBuilder
 * Rule Condition:
 - No
 [Condition.query_terms][google.cloud.retail.v2alpha.Condition.query_terms]
 provided is a global match.
 - 1 or more
 [Condition.query_terms][google.cloud.retail.v2alpha.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

  • Method Summary

    Modifier and Type
    Method
    Description
    Rule.FilterAction
    build()
     
    Rule.FilterAction
    buildPartial()
     
    Rule.FilterAction.Builder
    clear()
     
    Rule.FilterAction.Builder
    clearFilter()
    A filter to apply on the matching condition results.
    Rule.FilterAction
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    String
    getFilter()
    A filter to apply on the matching condition results.
    com.google.protobuf.ByteString
    getFilterBytes()
    A filter to apply on the matching condition results.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    Rule.FilterAction.Builder
    mergeFrom(Rule.FilterAction other)
     
    Rule.FilterAction.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    Rule.FilterAction.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    Rule.FilterAction.Builder
    setFilter(String value)
    A filter to apply on the matching condition results.
    Rule.FilterAction.Builder
    setFilterBytes(com.google.protobuf.ByteString value)
    A filter to apply on the matching condition results.

    Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.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.GeneratedMessage.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.GeneratedMessage.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

    • 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>

    • mergeFrom

      public Rule.FilterAction.Builder mergeFrom(Rule.FilterAction other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.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.v2alpha.Rule.FilterAction.filter] must be
 set.
 * Filter syntax is identical to
 [SearchRequest.filter][google.cloud.retail.v2alpha.SearchRequest.filter].
 For more
 information, see [Filter](/retail/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.v2alpha.Rule.FilterAction.filter] must be
 set.
 * Filter syntax is identical to
 [SearchRequest.filter][google.cloud.retail.v2alpha.SearchRequest.filter].
 For more
 information, see [Filter](/retail/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.v2alpha.Rule.FilterAction.filter] must be
 set.
 * Filter syntax is identical to
 [SearchRequest.filter][google.cloud.retail.v2alpha.SearchRequest.filter].
 For more
 information, see [Filter](/retail/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.v2alpha.Rule.FilterAction.filter] must be
 set.
 * Filter syntax is identical to
 [SearchRequest.filter][google.cloud.retail.v2alpha.SearchRequest.filter].
 For more
 information, see [Filter](/retail/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.v2alpha.Rule.FilterAction.filter] must be
 set.
 * Filter syntax is identical to
 [SearchRequest.filter][google.cloud.retail.v2alpha.SearchRequest.filter].
 For more
 information, see [Filter](/retail/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.