Class PinControlMetadata (2.5.0)

PinControlMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Metadata for pinning to be returned in the response. This is used for distinguishing between applied vs dropped pins.

Attributes
Name	Description
`all_matched_pins`	`MutableMapping[int, google.cloud.retail_v2alpha.types.PinControlMetadata.ProductPins]` Map of all matched pins, keyed by pin position.
`dropped_pins`	`MutableMapping[int, google.cloud.retail_v2alpha.types.PinControlMetadata.ProductPins]` Map of pins that were dropped due to overlap with other matching pins, keyed by pin position.

Classes

AllMatchedPinsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
`kwargs`	`dict` Keys and values corresponding to the fields of the message.
`mapping`	`Union[dict, .Message]` A dictionary or message to be used to determine the values for this message.
`ignore_unknown_fields`	`Optional(bool)` If True, do not raise errors for unknown fields. Only applied if `mapping` is a mapping type or there are keyword parameters.

DroppedPinsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
`kwargs`	`dict` Keys and values corresponding to the fields of the message.
`mapping`	`Union[dict, .Message]` A dictionary or message to be used to determine the values for this message.
`ignore_unknown_fields`	`Optional(bool)` If True, do not raise errors for unknown fields. Only applied if `mapping` is a mapping type or there are keyword parameters.

ProductPins(mapping=None, *, ignore_unknown_fields=False, **kwargs)

List of product ids which have associated pins.