Retail V2 API - Class Google::Cloud::Retail::V2::PinControlMetadata (v2.1.0)

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

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#all_matched_pins

def all_matched_pins() -> ::Google::Protobuf::Map{::Integer => ::Google::Cloud::Retail::V2::PinControlMetadata::ProductPins}
Returns
  • (::Google::Protobuf::Map{::Integer => ::Google::Cloud::Retail::V2::PinControlMetadata::ProductPins}) — Map of all matched pins, keyed by pin position.

#all_matched_pins=

def all_matched_pins=(value) -> ::Google::Protobuf::Map{::Integer => ::Google::Cloud::Retail::V2::PinControlMetadata::ProductPins}
Parameter
  • value (::Google::Protobuf::Map{::Integer => ::Google::Cloud::Retail::V2::PinControlMetadata::ProductPins}) — Map of all matched pins, keyed by pin position.
Returns
  • (::Google::Protobuf::Map{::Integer => ::Google::Cloud::Retail::V2::PinControlMetadata::ProductPins}) — Map of all matched pins, keyed by pin position.

#dropped_pins

def dropped_pins() -> ::Google::Protobuf::Map{::Integer => ::Google::Cloud::Retail::V2::PinControlMetadata::ProductPins}
Returns
  • (::Google::Protobuf::Map{::Integer => ::Google::Cloud::Retail::V2::PinControlMetadata::ProductPins}) — Map of pins that were dropped due to overlap with other matching pins, keyed by pin position.

#dropped_pins=

def dropped_pins=(value) -> ::Google::Protobuf::Map{::Integer => ::Google::Cloud::Retail::V2::PinControlMetadata::ProductPins}
Parameter
  • value (::Google::Protobuf::Map{::Integer => ::Google::Cloud::Retail::V2::PinControlMetadata::ProductPins}) — Map of pins that were dropped due to overlap with other matching pins, keyed by pin position.
Returns
  • (::Google::Protobuf::Map{::Integer => ::Google::Cloud::Retail::V2::PinControlMetadata::ProductPins}) — Map of pins that were dropped due to overlap with other matching pins, keyed by pin position.