Class MapValue (3.21.3)

public final class MapValue extends GeneratedMessageV3 implements MapValueOrBuilder

A map value.

Protobuf type google.firestore.v1.MapValue

Implements

MapValueOrBuilder

Static Fields

FIELDS_FIELD_NUMBER

public static final int FIELDS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static MapValue getDefaultInstance()
Returns
Type Description
MapValue

getDescriptor()

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

newBuilder()

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

newBuilder(MapValue prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

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

equals(Object obj)

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

getDefaultInstanceForType()

public MapValue getDefaultInstanceForType()
Returns
Type Description
MapValue

getFields() (deprecated)

public Map<String,Value> getFields()

Use #getFieldsMap() instead.

Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
key String
defaultValue Value
Returns
Type Description
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
Name Description
key String
Returns
Type Description
Value

getParserForType()

public Parser<MapValue> getParserForType()
Returns
Type Description
Parser<MapValue>
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 MapValue.Builder newBuilderForType()
Returns
Type Description
MapValue.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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