Class PinControlMetadata.Builder (2.85.0)

Version latest

• 2.85.0 (latest)
• 2.84.0
• 2.82.0
• 2.80.0
• 2.78.0
• 2.77.0
• 2.76.0
• 2.75.0
• 2.74.0
• 2.72.0
• 2.70.0
• 2.69.0
• 2.66.0
• 2.65.0
• 2.64.0
• 2.62.0
• 2.61.0
• 2.60.0
• 2.59.0
• 2.58.0
• 2.57.0
• 2.56.0
• 2.55.0
• 2.54.0
• 2.53.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.1
• 2.4.0
• 2.3.0
• 2.2.3
• 2.1.0
• 2.0.19

public static final class PinControlMetadata.Builder extends GeneratedMessage.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

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > PinControlMetadata.Builder

Implements

PinControlMetadataOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

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

GeneratedMessage.Builder<BuilderType>.clear()

clearAllMatchedPins()

public PinControlMetadata.Builder clearAllMatchedPins()

Returns
Type	Description
PinControlMetadata.Builder

clearDroppedPins()

public PinControlMetadata.Builder clearDroppedPins()

Returns
Type	Description
PinControlMetadata.Builder

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

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

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 GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessage.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.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public PinControlMetadata.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
PinControlMetadata.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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