Package com.google.cloud.retail.v2alpha

Interface Rule.PinActionOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Rule.PinAction, Rule.PinAction.Builder
Enclosing class:
Rule
public static interface Rule.PinActionOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsPinMap(long key)
    Required.
    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.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getPinMapCount

      int getPinMapCount()
       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];

    • containsPinMap

      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];

    • getPinMap

      @Deprecated Map<Long,String> getPinMap()
      Deprecated.
      Use getPinMapMap() instead.

    • getPinMapMap

      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];

    • getPinMapOrDefault

      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];

    • getPinMapOrThrow

      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];