Interface Rule.PinActionOrBuilder (2.89.0) 

public static interface Rule.PinActionOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsPinMap(long key)

public abstract 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.

map<int64, string> pin_map = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
key long
Returns
Type Description
boolean

getPinMap() (deprecated)

public abstract Map<Long,String> getPinMap()

Use #getPinMapMap() instead.

Returns
Type Description
Map<java.lang.Long,String>

getPinMapCount()

public abstract 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.

map<int64, string> pin_map = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getPinMapMap()

public abstract 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.

map<int64, string> pin_map = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Map<java.lang.Long,String>

getPinMapOrDefault(long key, String defaultValue)

public abstract 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.

map<int64, string> pin_map = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
key long
defaultValue String
Returns
Type Description
String

getPinMapOrThrow(long key)

public abstract 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.

map<int64, string> pin_map = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
key long
Returns
Type Description
String