Class: Google::Cloud::Retail::V2::PinControlMetadata

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/retail/v2/common.rb

Overview

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

Defined Under Namespace

Classes: AllMatchedPinsEntry, DroppedPinsEntry, ProductPins

Instance Attribute Summary collapse

Instance Attribute Details

#all_matched_pins ⇒ ::Google::Protobuf::Map{::Integer => ::Google::Cloud::Retail::V2::PinControlMetadata::ProductPins}

Returns Map of all matched pins, keyed by pin position.

Returns:



977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
 
# File 'proto_docs/google/cloud/retail/v2/common.rb', line 977

class PinControlMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # List of product ids which have associated pins.
  # @!attribute [rw] product_id
  #   @return [::Array<::String>]
  #     List of product ids which have associated pins.
  class ProductPins
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::Integer]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::PinControlMetadata::ProductPins]
  class AllMatchedPinsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::Integer]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::PinControlMetadata::ProductPins]
  class DroppedPinsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#dropped_pins ⇒ ::Google::Protobuf::Map{::Integer => ::Google::Cloud::Retail::V2::PinControlMetadata::ProductPins}

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

Returns:



977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
 
# File 'proto_docs/google/cloud/retail/v2/common.rb', line 977

class PinControlMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # List of product ids which have associated pins.
  # @!attribute [rw] product_id
  #   @return [::Array<::String>]
  #     List of product ids which have associated pins.
  class ProductPins
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::Integer]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::PinControlMetadata::ProductPins]
  class AllMatchedPinsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::Integer]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Retail::V2::PinControlMetadata::ProductPins]
  class DroppedPinsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end