Class MapValue.Builder (3.17.0)

public static final class MapValue.Builder extends GeneratedMessageV3.Builder<MapValue.Builder> implements MapValueOrBuilder

A map value.

Protobuf type google.firestore.v1.MapValue

Implements

MapValueOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public MapValue.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
MapValue.Builder
Overrides

build()

public MapValue build()
Returns
TypeDescription
MapValue

buildPartial()

public MapValue buildPartial()
Returns
TypeDescription
MapValue

clear()

public MapValue.Builder clear()
Returns
TypeDescription
MapValue.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public MapValue.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
MapValue.Builder
Overrides

clearFields()

public MapValue.Builder clearFields()
Returns
TypeDescription
MapValue.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public MapValue.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
MapValue.Builder
Overrides

clone()

public MapValue.Builder clone()
Returns
TypeDescription
MapValue.Builder
Overrides

containsFields(String key)

public boolean containsFields(String key)

The map's fields.

The map keys represent field names. Field names matching the regular expression .* are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.

map<string, .google.firestore.v1.Value> fields = 1;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getDefaultInstanceForType()

public MapValue getDefaultInstanceForType()
Returns
TypeDescription
MapValue

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFields()

public Map<String,Value> getFields()

Use #getFieldsMap() instead.

Returns
TypeDescription
Map<String,Value>

getFieldsCount()

public int getFieldsCount()

The map's fields.

The map keys represent field names. Field names matching the regular expression .* are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.

map<string, .google.firestore.v1.Value> fields = 1;

Returns
TypeDescription
int

getFieldsMap()

public Map<String,Value> getFieldsMap()

The map's fields.

The map keys represent field names. Field names matching the regular expression .* are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.

map<string, .google.firestore.v1.Value> fields = 1;

Returns
TypeDescription
Map<String,Value>

getFieldsOrDefault(String key, Value defaultValue)

public Value getFieldsOrDefault(String key, Value defaultValue)

The map's fields.

The map keys represent field names. Field names matching the regular expression .* are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.

map<string, .google.firestore.v1.Value> fields = 1;

Parameters
NameDescription
keyString
defaultValueValue
Returns
TypeDescription
Value

getFieldsOrThrow(String key)

public Value getFieldsOrThrow(String key)

The map's fields.

The map keys represent field names. Field names matching the regular expression .* are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.

map<string, .google.firestore.v1.Value> fields = 1;

Parameter
NameDescription
keyString
Returns
TypeDescription
Value

getMutableFields()

public Map<String,Value> getMutableFields()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,Value>

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(MapValue other)

public MapValue.Builder mergeFrom(MapValue other)
Parameter
NameDescription
otherMapValue
Returns
TypeDescription
MapValue.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public MapValue.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MapValue.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public MapValue.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
MapValue.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final MapValue.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
MapValue.Builder
Overrides

putAllFields(Map<String,Value> values)

public MapValue.Builder putAllFields(Map<String,Value> values)

The map's fields.

The map keys represent field names. Field names matching the regular expression .* are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.

map<string, .google.firestore.v1.Value> fields = 1;

Parameter
NameDescription
valuesMap<String,Value>
Returns
TypeDescription
MapValue.Builder

putFields(String key, Value value)

public MapValue.Builder putFields(String key, Value value)

The map's fields.

The map keys represent field names. Field names matching the regular expression .* are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.

map<string, .google.firestore.v1.Value> fields = 1;

Parameters
NameDescription
keyString
valueValue
Returns
TypeDescription
MapValue.Builder

putFieldsBuilderIfAbsent(String key)

public Value.Builder putFieldsBuilderIfAbsent(String key)

The map's fields.

The map keys represent field names. Field names matching the regular expression .* are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.

map<string, .google.firestore.v1.Value> fields = 1;

Parameter
NameDescription
keyString
Returns
TypeDescription
Value.Builder

removeFields(String key)

public MapValue.Builder removeFields(String key)

The map's fields.

The map keys represent field names. Field names matching the regular expression .* are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.

map<string, .google.firestore.v1.Value> fields = 1;

Parameter
NameDescription
keyString
Returns
TypeDescription
MapValue.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public MapValue.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
MapValue.Builder
Overrides

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

public MapValue.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
MapValue.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final MapValue.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
MapValue.Builder
Overrides