Package com.google.cloud.retail.v2alpha

Class PinControlMetadata

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.retail.v2alpha.PinControlMetadata
All Implemented Interfaces:
PinControlMetadataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class PinControlMetadata extends com.google.protobuf.GeneratedMessage implements PinControlMetadataOrBuilder
 Metadata for pinning to be returned in the response.
 This is used for distinguishing between applied vs dropped pins.
Protobuf type google.cloud.retail.v2alpha.PinControlMetadata
See Also:

  • Field Details

    • ALL_MATCHED_PINS_FIELD_NUMBER

      public static final int ALL_MATCHED_PINS_FIELD_NUMBER
      See Also:

    • DROPPED_PINS_FIELD_NUMBER

      public static final int DROPPED_PINS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getAllMatchedPinsCount

      public int getAllMatchedPinsCount()
      Description copied from interface: PinControlMetadataOrBuilder
       Map of all matched pins, keyed by pin position.
      map<int64, .google.cloud.retail.v2alpha.PinControlMetadata.ProductPins> all_matched_pins = 1;
      Specified by:
      getAllMatchedPinsCount in interface PinControlMetadataOrBuilder

    • containsAllMatchedPins

      public boolean containsAllMatchedPins(long key)
       Map of all matched pins, keyed by pin position.
      map<int64, .google.cloud.retail.v2alpha.PinControlMetadata.ProductPins> all_matched_pins = 1;
      Specified by:
      containsAllMatchedPins in interface PinControlMetadataOrBuilder

    • getAllMatchedPins

      @Deprecated public Map<Long,PinControlMetadata.ProductPins> getAllMatchedPins()
      Deprecated.
      Use getAllMatchedPinsMap() instead.
      Specified by:
      getAllMatchedPins in interface PinControlMetadataOrBuilder

    • getAllMatchedPinsMap

      public Map<Long,PinControlMetadata.ProductPins> getAllMatchedPinsMap()
       Map of all matched pins, keyed by pin position.
      map<int64, .google.cloud.retail.v2alpha.PinControlMetadata.ProductPins> all_matched_pins = 1;
      Specified by:
      getAllMatchedPinsMap in interface PinControlMetadataOrBuilder

    • getAllMatchedPinsOrDefault

      public PinControlMetadata.ProductPins getAllMatchedPinsOrDefault(long key, PinControlMetadata.ProductPins defaultValue)
       Map of all matched pins, keyed by pin position.
      map<int64, .google.cloud.retail.v2alpha.PinControlMetadata.ProductPins> all_matched_pins = 1;
      Specified by:
      getAllMatchedPinsOrDefault in interface PinControlMetadataOrBuilder

    • getAllMatchedPinsOrThrow

      public PinControlMetadata.ProductPins getAllMatchedPinsOrThrow(long key)
       Map of all matched pins, keyed by pin position.
      map<int64, .google.cloud.retail.v2alpha.PinControlMetadata.ProductPins> all_matched_pins = 1;
      Specified by:
      getAllMatchedPinsOrThrow in interface PinControlMetadataOrBuilder

    • getDroppedPinsCount

      public int getDroppedPinsCount()
      Description copied from interface: PinControlMetadataOrBuilder
       Map of pins that were dropped due to overlap with other matching pins,
 keyed by pin position.
      map<int64, .google.cloud.retail.v2alpha.PinControlMetadata.ProductPins> dropped_pins = 2;
      Specified by:
      getDroppedPinsCount in interface PinControlMetadataOrBuilder

    • containsDroppedPins

      public 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.v2alpha.PinControlMetadata.ProductPins> dropped_pins = 2;
      Specified by:
      containsDroppedPins in interface PinControlMetadataOrBuilder

    • getDroppedPins

      @Deprecated public Map<Long,PinControlMetadata.ProductPins> getDroppedPins()
      Deprecated.
      Use getDroppedPinsMap() instead.
      Specified by:
      getDroppedPins in interface PinControlMetadataOrBuilder

    • getDroppedPinsMap

      public 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.v2alpha.PinControlMetadata.ProductPins> dropped_pins = 2;
      Specified by:
      getDroppedPinsMap in interface PinControlMetadataOrBuilder

    • getDroppedPinsOrDefault

      public 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.v2alpha.PinControlMetadata.ProductPins> dropped_pins = 2;
      Specified by:
      getDroppedPinsOrDefault in interface PinControlMetadataOrBuilder

    • getDroppedPinsOrThrow

      public 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.v2alpha.PinControlMetadata.ProductPins> dropped_pins = 2;
      Specified by:
      getDroppedPinsOrThrow in interface PinControlMetadataOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static PinControlMetadata parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PinControlMetadata parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PinControlMetadata parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PinControlMetadata parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PinControlMetadata parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PinControlMetadata parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PinControlMetadata parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PinControlMetadata parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PinControlMetadata parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PinControlMetadata parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PinControlMetadata parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PinControlMetadata parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public PinControlMetadata.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static PinControlMetadata.Builder newBuilder()

    • newBuilder

      public static PinControlMetadata.Builder newBuilder(PinControlMetadata prototype)

    • toBuilder

      public PinControlMetadata.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected PinControlMetadata.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static PinControlMetadata getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<PinControlMetadata> parser()

    • getParserForType

      public com.google.protobuf.Parser<PinControlMetadata> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public PinControlMetadata getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder