Package com.google.cloud.retail.v2alpha

Class Rule.PinAction

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.retail.v2alpha.Rule.PinAction
All Implemented Interfaces:
Rule.PinActionOrBuilder, 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.PinAction extends com.google.protobuf.GeneratedMessage implements Rule.PinActionOrBuilder
 Pins one or more specified products to a specific position in the
 results.

 * Rule Condition:
 Must specify non-empty
 [Condition.query_terms][google.cloud.retail.v2alpha.Condition.query_terms]
 (for search only) or
 [Condition.page_categories][google.cloud.retail.v2alpha.Condition.page_categories]
 (for browse only), but can't specify both.

 * Action Input: mapping of `[pin_position, product_id]` pairs (pin position
 uses 1-based indexing).

 * Action Result: Will pin products with matching ids to the position
 specified in the final result order.

 Example: Suppose the query is `shoes`, the
 [Condition.query_terms][google.cloud.retail.v2alpha.Condition.query_terms]
 is `shoes` and the pin_map has `{1, "pid1"}`, then product with `pid1` will
 be pinned to the top position in the final results.

 If multiple PinActions are matched to a single request the actions will
 be processed from most to least recently updated.

 Pins to positions larger than the max allowed page size of 120 are not
 allowed.
Protobuf type google.cloud.retail.v2alpha.Rule.PinAction
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Rule.PinAction.Builder
    Pins one or more specified products to a specific position in the results

    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
    PIN_MAP_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
    containsPinMap(long key)
    Required.
    boolean
    equals(Object obj)
     
    static Rule.PinAction
    getDefaultInstance()
     
    Rule.PinAction
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<Rule.PinAction>
    getParserForType()
     
    Map<Long,String>
    getPinMap()
    Deprecated.
    int
    getPinMapCount()
    Required.
    Map<Long,String>
    getPinMapMap()
    Required.
    String
    getPinMapOrDefault(long key, String defaultValue)
    Required.
    String
    getPinMapOrThrow(long key)
    Required.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    protected com.google.protobuf.MapFieldReflectionAccessor
    internalGetMapFieldReflection(int number)
     
    final boolean
    isInitialized()
     
    static Rule.PinAction.Builder
    newBuilder()
     
    static Rule.PinAction.Builder
    newBuilder(Rule.PinAction prototype)
     
    Rule.PinAction.Builder
    newBuilderForType()
     
    protected Rule.PinAction.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Rule.PinAction
    parseDelimitedFrom(InputStream input)
     
    static Rule.PinAction
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Rule.PinAction
    parseFrom(byte[] data)
     
    static Rule.PinAction
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Rule.PinAction
    parseFrom(com.google.protobuf.ByteString data)
     
    static Rule.PinAction
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Rule.PinAction
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Rule.PinAction
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Rule.PinAction
    parseFrom(InputStream input)
     
    static Rule.PinAction
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Rule.PinAction
    parseFrom(ByteBuffer data)
     
    static Rule.PinAction
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Rule.PinAction>
    parser()
     
    Rule.PinAction.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, 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

  • Method Details

    • getDescriptor

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

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getPinMapCount

      public int getPinMapCount()
      Description copied from interface: Rule.PinActionOrBuilder
       Required. A map of positions to product_ids.

 Partial matches per action are allowed, if a certain position in the map
 is already filled that `[position, product_id]` pair will be ignored
 but the rest may still be applied. This case will only occur if multiple
 pin actions are matched to a single request, as the map guarantees that
 pin positions are unique within the same action.

 Duplicate product_ids are not permitted within a single pin map.

 The max size of this map is 120, equivalent to the max [request page
 size](https://cloud.google.com/retail/docs/reference/rest/v2/projects.locations.catalogs.placements/search#request-body).
      map<int64, string> pin_map = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getPinMapCount in interface Rule.PinActionOrBuilder

    • containsPinMap

      public boolean containsPinMap(long key)
       Required. A map of positions to product_ids.

 Partial matches per action are allowed, if a certain position in the map
 is already filled that `[position, product_id]` pair will be ignored
 but the rest may still be applied. This case will only occur if multiple
 pin actions are matched to a single request, as the map guarantees that
 pin positions are unique within the same action.

 Duplicate product_ids are not permitted within a single pin map.

 The max size of this map is 120, equivalent to the max [request page
 size](https://cloud.google.com/retail/docs/reference/rest/v2/projects.locations.catalogs.placements/search#request-body).
      map<int64, string> pin_map = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      containsPinMap in interface Rule.PinActionOrBuilder

    • getPinMap

      @Deprecated public Map<Long,String> getPinMap()
      Deprecated.
      Use getPinMapMap() instead.
      Specified by:
      getPinMap in interface Rule.PinActionOrBuilder

    • getPinMapMap

      public Map<Long,String> getPinMapMap()
       Required. A map of positions to product_ids.

 Partial matches per action are allowed, if a certain position in the map
 is already filled that `[position, product_id]` pair will be ignored
 but the rest may still be applied. This case will only occur if multiple
 pin actions are matched to a single request, as the map guarantees that
 pin positions are unique within the same action.

 Duplicate product_ids are not permitted within a single pin map.

 The max size of this map is 120, equivalent to the max [request page
 size](https://cloud.google.com/retail/docs/reference/rest/v2/projects.locations.catalogs.placements/search#request-body).
      map<int64, string> pin_map = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getPinMapMap in interface Rule.PinActionOrBuilder

    • getPinMapOrDefault

      public String getPinMapOrDefault(long key, String defaultValue)
       Required. A map of positions to product_ids.

 Partial matches per action are allowed, if a certain position in the map
 is already filled that `[position, product_id]` pair will be ignored
 but the rest may still be applied. This case will only occur if multiple
 pin actions are matched to a single request, as the map guarantees that
 pin positions are unique within the same action.

 Duplicate product_ids are not permitted within a single pin map.

 The max size of this map is 120, equivalent to the max [request page
 size](https://cloud.google.com/retail/docs/reference/rest/v2/projects.locations.catalogs.placements/search#request-body).
      map<int64, string> pin_map = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getPinMapOrDefault in interface Rule.PinActionOrBuilder

    • getPinMapOrThrow

      public String getPinMapOrThrow(long key)
       Required. A map of positions to product_ids.

 Partial matches per action are allowed, if a certain position in the map
 is already filled that `[position, product_id]` pair will be ignored
 but the rest may still be applied. This case will only occur if multiple
 pin actions are matched to a single request, as the map guarantees that
 pin positions are unique within the same action.

 Duplicate product_ids are not permitted within a single pin map.

 The max size of this map is 120, equivalent to the max [request page
 size](https://cloud.google.com/retail/docs/reference/rest/v2/projects.locations.catalogs.placements/search#request-body).
      map<int64, string> pin_map = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getPinMapOrThrow in interface Rule.PinActionOrBuilder

    • 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.PinAction parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Rule.PinAction 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.PinAction parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Rule.PinAction.Builder newBuilder()

    • newBuilder

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

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Rule.PinAction getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Rule.PinAction> 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.PinAction getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder