Interface PinControlMetadataOrBuilder (2.64.0)

public interface PinControlMetadataOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAllMatchedPins(long key)

public abstract boolean containsAllMatchedPins(long key)

Map of all matched pins, keyed by pin position.

map<int64, .google.cloud.retail.v2beta.PinControlMetadata.ProductPins> all_matched_pins = 1;

Parameter
Name Description
key long
Returns
Type Description
boolean

containsDroppedPins(long key)

public abstract boolean containsDroppedPins(long key)

Map of pins that were dropped due to overlap with other matching pins, keyed by pin position.

map<int64, .google.cloud.retail.v2beta.PinControlMetadata.ProductPins> dropped_pins = 2;

Parameter
Name Description
key long
Returns
Type Description
boolean

getAllMatchedPins() (deprecated)

public abstract Map<Long,PinControlMetadata.ProductPins> getAllMatchedPins()
Returns
Type Description
Map<java.lang.Long,ProductPins>

getAllMatchedPinsCount()

public abstract int getAllMatchedPinsCount()

Map of all matched pins, keyed by pin position.

map<int64, .google.cloud.retail.v2beta.PinControlMetadata.ProductPins> all_matched_pins = 1;

Returns
Type Description
int

getAllMatchedPinsMap()

public abstract Map<Long,PinControlMetadata.ProductPins> getAllMatchedPinsMap()

Map of all matched pins, keyed by pin position.

map<int64, .google.cloud.retail.v2beta.PinControlMetadata.ProductPins> all_matched_pins = 1;

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

getAllMatchedPinsOrDefault(long key, PinControlMetadata.ProductPins defaultValue)

public abstract PinControlMetadata.ProductPins getAllMatchedPinsOrDefault(long key, PinControlMetadata.ProductPins defaultValue)

Map of all matched pins, keyed by pin position.

map<int64, .google.cloud.retail.v2beta.PinControlMetadata.ProductPins> all_matched_pins = 1;

Parameters
Name Description
key long
defaultValue PinControlMetadata.ProductPins
Returns
Type Description
PinControlMetadata.ProductPins

getAllMatchedPinsOrThrow(long key)

public abstract PinControlMetadata.ProductPins getAllMatchedPinsOrThrow(long key)

Map of all matched pins, keyed by pin position.

map<int64, .google.cloud.retail.v2beta.PinControlMetadata.ProductPins> all_matched_pins = 1;

Parameter
Name Description
key long
Returns
Type Description
PinControlMetadata.ProductPins

getDroppedPins() (deprecated)

public abstract Map<Long,PinControlMetadata.ProductPins> getDroppedPins()

Use #getDroppedPinsMap() instead.

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

getDroppedPinsCount()

public abstract int getDroppedPinsCount()

Map of pins that were dropped due to overlap with other matching pins, keyed by pin position.

map<int64, .google.cloud.retail.v2beta.PinControlMetadata.ProductPins> dropped_pins = 2;

Returns
Type Description
int

getDroppedPinsMap()

public abstract Map<Long,PinControlMetadata.ProductPins> getDroppedPinsMap()

Map of pins that were dropped due to overlap with other matching pins, keyed by pin position.

map<int64, .google.cloud.retail.v2beta.PinControlMetadata.ProductPins> dropped_pins = 2;

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

getDroppedPinsOrDefault(long key, PinControlMetadata.ProductPins defaultValue)

public abstract PinControlMetadata.ProductPins getDroppedPinsOrDefault(long key, PinControlMetadata.ProductPins defaultValue)

Map of pins that were dropped due to overlap with other matching pins, keyed by pin position.

map<int64, .google.cloud.retail.v2beta.PinControlMetadata.ProductPins> dropped_pins = 2;

Parameters
Name Description
key long
defaultValue PinControlMetadata.ProductPins
Returns
Type Description
PinControlMetadata.ProductPins

getDroppedPinsOrThrow(long key)

public abstract PinControlMetadata.ProductPins getDroppedPinsOrThrow(long key)

Map of pins that were dropped due to overlap with other matching pins, keyed by pin position.

map<int64, .google.cloud.retail.v2beta.PinControlMetadata.ProductPins> dropped_pins = 2;

Parameter
Name Description
key long
Returns
Type Description
PinControlMetadata.ProductPins