Class PinControlMetadata (2.64.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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > PinControlMetadata

Static Fields

ALL_MATCHED_PINS_FIELD_NUMBER

public static final int ALL_MATCHED_PINS_FIELD_NUMBER
Field Value
Type Description
int

DROPPED_PINS_FIELD_NUMBER

public static final int DROPPED_PINS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PinControlMetadata getDefaultInstance()
Returns
Type Description
PinControlMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PinControlMetadata.Builder newBuilder()
Returns
Type Description
PinControlMetadata.Builder

newBuilder(PinControlMetadata prototype)

public static PinControlMetadata.Builder newBuilder(PinControlMetadata prototype)
Parameter
Name Description
prototype PinControlMetadata
Returns
Type Description
PinControlMetadata.Builder

parseDelimitedFrom(InputStream input)

public static PinControlMetadata parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PinControlMetadata
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PinControlMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PinControlMetadata
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PinControlMetadata parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PinControlMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PinControlMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PinControlMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PinControlMetadata parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PinControlMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PinControlMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PinControlMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PinControlMetadata parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PinControlMetadata
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PinControlMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PinControlMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PinControlMetadata parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PinControlMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PinControlMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PinControlMetadata
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PinControlMetadata parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PinControlMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PinControlMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PinControlMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PinControlMetadata> parser()
Returns
Type Description
Parser<PinControlMetadata>

Methods

containsAllMatchedPins(long key)

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
Returns
Type Description
boolean

containsDroppedPins(long key)

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
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAllMatchedPins() (deprecated)

public Map<Long,PinControlMetadata.ProductPins> getAllMatchedPins()

Use #getAllMatchedPinsMap() instead.

Returns
Type Description
Map<java.lang.Long,ProductPins>

getAllMatchedPinsCount()

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

getAllMatchedPinsMap()

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;

Returns
Type Description
Map<java.lang.Long,ProductPins>

getAllMatchedPinsOrDefault(long key, PinControlMetadata.ProductPins defaultValue)

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;

Parameters
Name Description
key long
defaultValue PinControlMetadata.ProductPins
Returns
Type Description
PinControlMetadata.ProductPins

getAllMatchedPinsOrThrow(long key)

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
Returns
Type Description
PinControlMetadata.ProductPins

getDefaultInstanceForType()

public PinControlMetadata getDefaultInstanceForType()
Returns
Type Description
PinControlMetadata

getDroppedPins() (deprecated)

public Map<Long,PinControlMetadata.ProductPins> getDroppedPins()

Use #getDroppedPinsMap() instead.

Returns
Type Description
Map<java.lang.Long,ProductPins>

getDroppedPinsCount()

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

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.v2beta.PinControlMetadata.ProductPins> dropped_pins = 2;

Returns
Type Description
Map<java.lang.Long,ProductPins>

getDroppedPinsOrDefault(long key, PinControlMetadata.ProductPins defaultValue)

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;

Parameters
Name Description
key long
defaultValue PinControlMetadata.ProductPins
Returns
Type Description
PinControlMetadata.ProductPins

getDroppedPinsOrThrow(long key)

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
Returns
Type Description
PinControlMetadata.ProductPins

getParserForType()

public Parser<PinControlMetadata> getParserForType()
Returns
Type Description
Parser<PinControlMetadata>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PinControlMetadata.Builder newBuilderForType()
Returns
Type Description
PinControlMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PinControlMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PinControlMetadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PinControlMetadata.Builder toBuilder()
Returns
Type Description
PinControlMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException