Class PinControlMetadata.Builder (2.64.0) 

public static final class PinControlMetadata.Builder extends GeneratedMessageV3.Builder<PinControlMetadata.Builder> 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.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PinControlMetadata.Builder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PinControlMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PinControlMetadata.Builder
Overrides

build()

public PinControlMetadata build()
Returns
Type Description
PinControlMetadata

buildPartial()

public PinControlMetadata buildPartial()
Returns
Type Description
PinControlMetadata

clear()

public PinControlMetadata.Builder clear()
Returns
Type Description
PinControlMetadata.Builder
Overrides

clearAllMatchedPins()

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

clearDroppedPins()

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

clearField(Descriptors.FieldDescriptor field)

public PinControlMetadata.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
PinControlMetadata.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public PinControlMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
PinControlMetadata.Builder
Overrides

clone()

public PinControlMetadata.Builder clone()
Returns
Type Description
PinControlMetadata.Builder
Overrides

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

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

getMutableAllMatchedPins() (deprecated)

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

Use alternate mutation accessors instead.

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

getMutableDroppedPins() (deprecated)

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

Use alternate mutation accessors instead.

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

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.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(PinControlMetadata other)

public PinControlMetadata.Builder mergeFrom(PinControlMetadata other)
Parameter
Name Description
other PinControlMetadata
Returns
Type Description
PinControlMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PinControlMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PinControlMetadata.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public PinControlMetadata.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
PinControlMetadata.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PinControlMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PinControlMetadata.Builder
Overrides

putAllAllMatchedPins(Map<Long,PinControlMetadata.ProductPins> values)

public PinControlMetadata.Builder putAllAllMatchedPins(Map<Long,PinControlMetadata.ProductPins> values)

Map of all matched pins, keyed by pin position.

map<int64, .google.cloud.retail.v2beta.PinControlMetadata.ProductPins> all_matched_pins = 1;

Parameter
Name Description
values Map<java.lang.Long,ProductPins>
Returns
Type Description
PinControlMetadata.Builder

putAllDroppedPins(Map<Long,PinControlMetadata.ProductPins> values)

public PinControlMetadata.Builder putAllDroppedPins(Map<Long,PinControlMetadata.ProductPins> values)

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
values Map<java.lang.Long,ProductPins>
Returns
Type Description
PinControlMetadata.Builder

putAllMatchedPins(long key, PinControlMetadata.ProductPins value)

public PinControlMetadata.Builder putAllMatchedPins(long key, PinControlMetadata.ProductPins value)

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

putAllMatchedPinsBuilderIfAbsent(long key)

public PinControlMetadata.ProductPins.Builder putAllMatchedPinsBuilderIfAbsent(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.Builder

putDroppedPins(long key, PinControlMetadata.ProductPins value)

public PinControlMetadata.Builder putDroppedPins(long key, PinControlMetadata.ProductPins value)

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

putDroppedPinsBuilderIfAbsent(long key)

public PinControlMetadata.ProductPins.Builder putDroppedPinsBuilderIfAbsent(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.Builder

removeAllMatchedPins(long key)

public PinControlMetadata.Builder removeAllMatchedPins(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.Builder

removeDroppedPins(long key)

public PinControlMetadata.Builder removeDroppedPins(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.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public PinControlMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PinControlMetadata.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public PinControlMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
PinControlMetadata.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final PinControlMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PinControlMetadata.Builder
Overrides