Class PinControlMetadata (2.78.0)
public final class PinControlMetadata extends GeneratedMessageV3 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.v2beta.PinControlMetadata
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int ALL_MATCHED_PINS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int DROPPED_PINS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static PinControlMetadata getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static PinControlMetadata.Builder newBuilder()
public static PinControlMetadata.Builder newBuilder(PinControlMetadata prototype)
public static PinControlMetadata parseDelimitedFrom(InputStream input)
public static PinControlMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static PinControlMetadata parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static PinControlMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PinControlMetadata parseFrom(ByteString data)
public static PinControlMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PinControlMetadata parseFrom(CodedInputStream input)
public static PinControlMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static PinControlMetadata parseFrom(InputStream input)
public static PinControlMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static PinControlMetadata parseFrom(ByteBuffer data)
public static PinControlMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<PinControlMetadata> parser()
Methods
public boolean containsAllMatchedPins(long key)
Map of all matched pins, keyed by pin position.
map<int64, .google.cloud.retail.v2beta.PinControlMetadata.ProductPins> all_matched_pins = 1;
| Parameter |
| Name |
Description |
key |
long
|
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.v2beta.PinControlMetadata.ProductPins> dropped_pins = 2;
| Parameter |
| Name |
Description |
key |
long
|
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public Map<Long,PinControlMetadata.ProductPins> getAllMatchedPins()
public int getAllMatchedPinsCount()
Map of all matched pins, keyed by pin position.
map<int64, .google.cloud.retail.v2beta.PinControlMetadata.ProductPins> all_matched_pins = 1;
| Returns |
| Type |
Description |
int |
|
public Map<Long,PinControlMetadata.ProductPins> getAllMatchedPinsMap()
Map of all matched pins, keyed by pin position.
map<int64, .google.cloud.retail.v2beta.PinControlMetadata.ProductPins> all_matched_pins = 1;
public PinControlMetadata.ProductPins getAllMatchedPinsOrDefault(long key, PinControlMetadata.ProductPins defaultValue)
Map of all matched pins, keyed by pin position.
map<int64, .google.cloud.retail.v2beta.PinControlMetadata.ProductPins> all_matched_pins = 1;
public PinControlMetadata.ProductPins getAllMatchedPinsOrThrow(long key)
Map of all matched pins, keyed by pin position.
map<int64, .google.cloud.retail.v2beta.PinControlMetadata.ProductPins> all_matched_pins = 1;
| Parameter |
| Name |
Description |
key |
long
|
public PinControlMetadata getDefaultInstanceForType()
public Map<Long,PinControlMetadata.ProductPins> getDroppedPins()
public int getDroppedPinsCount()
Map of pins that were dropped due to overlap with other matching pins,
keyed by pin position.
map<int64, .google.cloud.retail.v2beta.PinControlMetadata.ProductPins> dropped_pins = 2;
| Returns |
| Type |
Description |
int |
|
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.v2beta.PinControlMetadata.ProductPins> dropped_pins = 2;
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.v2beta.PinControlMetadata.ProductPins> dropped_pins = 2;
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.v2beta.PinControlMetadata.ProductPins> dropped_pins = 2;
| Parameter |
| Name |
Description |
key |
long
|
public Parser<PinControlMetadata> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
public final boolean isInitialized()
Overrides
public PinControlMetadata.Builder newBuilderForType()
protected PinControlMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public PinControlMetadata.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-11 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-11 UTC."],[],[]]
