Package com.google.cloud.retail.v2alpha

Class Rule.BoostAction

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.retail.v2alpha.Rule.BoostAction
All Implemented Interfaces:
Rule.BoostActionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
Rule
public static final class Rule.BoostAction extends com.google.protobuf.GeneratedMessage implements Rule.BoostActionOrBuilder
 A boost action to apply to results matching condition specified above.
Protobuf type google.cloud.retail.v2alpha.Rule.BoostAction
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Rule.BoostAction.Builder
    A boost action to apply to results matching condition specified above.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    BOOST_FIELD_NUMBER
     
    static final int
    PRODUCTS_FILTER_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    float
    getBoost()
    Strength of the condition boost, which must be in [-1, 1].
    static Rule.BoostAction
    getDefaultInstance()
     
    Rule.BoostAction
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<Rule.BoostAction>
    getParserForType()
     
    String
    getProductsFilter()
    The filter can have a max size of 5000 characters.
    com.google.protobuf.ByteString
    getProductsFilterBytes()
    The filter can have a max size of 5000 characters.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Rule.BoostAction.Builder
    newBuilder()
     
    static Rule.BoostAction.Builder
    newBuilder(Rule.BoostAction prototype)
     
    Rule.BoostAction.Builder
    newBuilderForType()
     
    protected Rule.BoostAction.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Rule.BoostAction
    parseDelimitedFrom(InputStream input)
     
    static Rule.BoostAction
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Rule.BoostAction
    parseFrom(byte[] data)
     
    static Rule.BoostAction
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Rule.BoostAction
    parseFrom(com.google.protobuf.ByteString data)
     
    static Rule.BoostAction
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Rule.BoostAction
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Rule.BoostAction
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Rule.BoostAction
    parseFrom(InputStream input)
     
    static Rule.BoostAction
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Rule.BoostAction
    parseFrom(ByteBuffer data)
     
    static Rule.BoostAction
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Rule.BoostAction>
    parser()
     
    Rule.BoostAction.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • BOOST_FIELD_NUMBER

      public static final int BOOST_FIELD_NUMBER
      See Also:

    • PRODUCTS_FILTER_FIELD_NUMBER

      public static final int PRODUCTS_FILTER_FIELD_NUMBER
      See Also:

  • 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

    • getBoost

      public float getBoost()
       Strength of the condition boost, which must be in [-1, 1]. Negative
 boost means demotion. Default is 0.0.

 Setting to 1.0 gives the item a big promotion. However, it does not
 necessarily mean that the boosted item will be the top result at all
 times, nor that other items will be excluded. Results could still be
 shown even when none of them matches the condition. And results that
 are significantly more relevant to the search query can still trump
 your heavily favored but irrelevant items.

 Setting to -1.0 gives the item a big demotion. However, results that
 are deeply relevant might still be shown. The item will have an
 upstream battle to get a fairly high ranking, but it is not blocked out
 completely.

 Setting to 0.0 means no boost applied. The boosting condition is
 ignored.
      float boost = 1;
      Specified by:
      getBoost in interface Rule.BoostActionOrBuilder
      Returns:
      The boost.

    • getProductsFilter

      public String getProductsFilter()
       The filter can have a max size of 5000 characters.
 An expression which specifies which products to apply an action to.
 The syntax and supported fields are the same as a filter expression. See
 [SearchRequest.filter][google.cloud.retail.v2alpha.SearchRequest.filter]
 for detail syntax and limitations.

 Examples:

 * To boost 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 products_filter = 2;
      Specified by:
      getProductsFilter in interface Rule.BoostActionOrBuilder
      Returns:
      The productsFilter.

    • getProductsFilterBytes

      public com.google.protobuf.ByteString getProductsFilterBytes()
       The filter can have a max size of 5000 characters.
 An expression which specifies which products to apply an action to.
 The syntax and supported fields are the same as a filter expression. See
 [SearchRequest.filter][google.cloud.retail.v2alpha.SearchRequest.filter]
 for detail syntax and limitations.

 Examples:

 * To boost 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 products_filter = 2;
      Specified by:
      getProductsFilterBytes in interface Rule.BoostActionOrBuilder
      Returns:
      The bytes for productsFilter.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Rule.BoostAction parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Rule.BoostAction parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Rule.BoostAction parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Rule.BoostAction parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Rule.BoostAction parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Rule.BoostAction parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Rule.BoostAction parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Rule.BoostAction parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Rule.BoostAction parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Rule.BoostAction parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Rule.BoostAction parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Rule.BoostAction parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static Rule.BoostAction.Builder newBuilder()

    • newBuilder

      public static Rule.BoostAction.Builder newBuilder(Rule.BoostAction prototype)

    • toBuilder

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

    • newBuilderForType

      protected Rule.BoostAction.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Rule.BoostAction getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Rule.BoostAction> parser()

    • getParserForType

      public com.google.protobuf.Parser<Rule.BoostAction> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

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