Google Cloud Retail V2 Client - Class PinControlMetadata (2.3.1)

Reference documentation and code samples for the Google Cloud Retail V2 Client class PinControlMetadata.

Metadata for pinning to be returned in the response.

This is used for distinguishing between applied vs dropped pins.

Generated from protobuf message google.cloud.retail.v2.PinControlMetadata

Namespace

Google \ Cloud \ Retail \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ all_matched_pins array|Google\Protobuf\Internal\MapField

Map of all matched pins, keyed by pin position.
↳ dropped_pins array|Google\Protobuf\Internal\MapField

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

getAllMatchedPins

Map of all matched pins, keyed by pin position.

Returns
Type Description
Google\Protobuf\Internal\MapField

setAllMatchedPins

Map of all matched pins, keyed by pin position.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getDroppedPins

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

Returns
Type Description
Google\Protobuf\Internal\MapField

setDroppedPins

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

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this