Class MapValue (3.20.0)

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
TypeDescription
int

Static Methods

getDefaultInstance()

public static MapValue getDefaultInstance()
Returns
TypeDescription
MapValue

getDescriptor()

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

newBuilder()

public static MapValue.Builder newBuilder()
Returns
TypeDescription
MapValue.Builder

newBuilder(MapValue prototype)

public static MapValue.Builder newBuilder(MapValue prototype)
Parameter
NameDescription
prototypeMapValue
Returns
TypeDescription
MapValue.Builder

parseDelimitedFrom(InputStream input)

public static MapValue parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
MapValue
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MapValue parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MapValue
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static MapValue parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
MapValue
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static MapValue parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MapValue
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static MapValue parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
MapValue
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static MapValue parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MapValue
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static MapValue parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
MapValue
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static MapValue parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MapValue
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static MapValue parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
MapValue
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MapValue parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MapValue
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static MapValue parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
MapValue
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static MapValue parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MapValue
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<MapValue> parser()
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public MapValue getDefaultInstanceForType()
Returns
TypeDescription
MapValue

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

getParserForType()

public Parser<MapValue> getParserForType()
Returns
TypeDescription
Parser<MapValue>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

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

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected MapValue.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
MapValue.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException