Class BundleElement (3.6.0)

Version 3.6.0

• 3.28.0 (latest)
• 3.27.2
• 3.26.5
• 3.25.1
• 3.24.3
• 3.22.0
• 3.21.4
• 3.20.0
• 3.17.0
• 3.16.3
• 3.15.7
• 3.14.4
• 3.13.2
• 3.12.1
• 3.11.0
• 3.10.0
• 3.9.6
• 3.8.2
• 3.7.10
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.21

public final class BundleElement extends GeneratedMessageV3 implements BundleElementOrBuilder

A Firestore bundle is a length-prefixed stream of JSON representations of BundleElement. Only one BundleMetadata is expected, and it should be the first element. The named queries follow after metadata. Every document_metadata is immediately followed by a document.

Protobuf type google.firestore.bundle.BundleElement

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > BundleElement

Implements

BundleElementOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

DOCUMENT_FIELD_NUMBER

public static final int DOCUMENT_FIELD_NUMBER

Field Value

Type	Description
int

DOCUMENT_METADATA_FIELD_NUMBER

public static final int DOCUMENT_METADATA_FIELD_NUMBER

Field Value

Type	Description
int

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER

Field Value

Type	Description
int

NAMED_QUERY_FIELD_NUMBER

public static final int NAMED_QUERY_FIELD_NUMBER

Field Value

Type	Description
int

Static Methods

getDefaultInstance()

public static BundleElement getDefaultInstance()

Returns

Type	Description
BundleElement

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

newBuilder()

public static BundleElement.Builder newBuilder()

Returns

Type	Description
BundleElement.Builder

newBuilder(BundleElement prototype)

public static BundleElement.Builder newBuilder(BundleElement prototype)

Parameter

Name	Description
prototype	BundleElement

Returns

Type	Description
BundleElement.Builder

parseDelimitedFrom(InputStream input)

public static BundleElement parseDelimitedFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
BundleElement

Exceptions

Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BundleElement parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
BundleElement

Exceptions

Type	Description
IOException

parseFrom(byte[] data)

public static BundleElement parseFrom(byte[] data)

Parameter

Name	Description
data	byte[]

Returns

Type	Description
BundleElement

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BundleElement parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
BundleElement

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BundleElement parseFrom(ByteString data)

Parameter

Name	Description
data	ByteString

Returns

Type	Description
BundleElement

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BundleElement parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
BundleElement

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BundleElement parseFrom(CodedInputStream input)

Parameter

Name	Description
input	CodedInputStream

Returns

Type	Description
BundleElement

Exceptions

Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BundleElement parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
BundleElement

Exceptions

Type	Description
IOException

parseFrom(InputStream input)

public static BundleElement parseFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
BundleElement

Exceptions

Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BundleElement parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
BundleElement

Exceptions

Type	Description
IOException

parseFrom(ByteBuffer data)

public static BundleElement parseFrom(ByteBuffer data)

Parameter

Name	Description
data	ByteBuffer

Returns

Type	Description
BundleElement

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BundleElement parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
BundleElement

Exceptions

Type	Description
InvalidProtocolBufferException

parser()

public static Parser<BundleElement> parser()

Returns

Type	Description
Parser<BundleElement>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
obj	Object

Returns

Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public BundleElement getDefaultInstanceForType()

Returns

Type	Description
BundleElement

getDocument()

public Document getDocument()

.google.firestore.v1.Document document = 4;

Returns

Type	Description
Document	The document.

getDocumentMetadata()

public BundledDocumentMetadata getDocumentMetadata()

.google.firestore.bundle.BundledDocumentMetadata document_metadata = 3;

Returns

Type	Description
BundledDocumentMetadata	The documentMetadata.

getDocumentMetadataOrBuilder()

public BundledDocumentMetadataOrBuilder getDocumentMetadataOrBuilder()

.google.firestore.bundle.BundledDocumentMetadata document_metadata = 3;

Returns

Type	Description
BundledDocumentMetadataOrBuilder

getDocumentOrBuilder()

public DocumentOrBuilder getDocumentOrBuilder()

.google.firestore.v1.Document document = 4;

Returns

Type	Description
DocumentOrBuilder

getElementTypeCase()

public BundleElement.ElementTypeCase getElementTypeCase()

Returns

Type	Description
BundleElement.ElementTypeCase

getMetadata()

public BundleMetadata getMetadata()

.google.firestore.bundle.BundleMetadata metadata = 1;

Returns

Type	Description
BundleMetadata	The metadata.

getMetadataOrBuilder()

public BundleMetadataOrBuilder getMetadataOrBuilder()

.google.firestore.bundle.BundleMetadata metadata = 1;

Returns

Type	Description
BundleMetadataOrBuilder

getNamedQuery()

public NamedQuery getNamedQuery()

.google.firestore.bundle.NamedQuery named_query = 2;

Returns

Type	Description
NamedQuery	The namedQuery.

getNamedQueryOrBuilder()

public NamedQueryOrBuilder getNamedQueryOrBuilder()

.google.firestore.bundle.NamedQuery named_query = 2;

Returns

Type	Description
NamedQueryOrBuilder

getParserForType()

public Parser<BundleElement> getParserForType()

Returns

Type	Description
Parser<BundleElement>

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

hasDocument()

public boolean hasDocument()

.google.firestore.v1.Document document = 4;

Returns

Type	Description
boolean	Whether the document field is set.

hasDocumentMetadata()

public boolean hasDocumentMetadata()

.google.firestore.bundle.BundledDocumentMetadata document_metadata = 3;

Returns

Type	Description
boolean	Whether the documentMetadata field is set.

hasMetadata()

public boolean hasMetadata()

.google.firestore.bundle.BundleMetadata metadata = 1;

Returns

Type	Description
boolean	Whether the metadata field is set.

hasNamedQuery()

public boolean hasNamedQuery()

.google.firestore.bundle.NamedQuery named_query = 2;

Returns

Type	Description
boolean	Whether the namedQuery field is set.

hashCode()

public int hashCode()

Returns

Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public BundleElement.Builder newBuilderForType()

Returns

Type	Description
BundleElement.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BundleElement.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter

Name	Description
parent	BuilderParent

Returns

Type	Description
BundleElement.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	UnusedPrivateParameter

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public BundleElement.Builder toBuilder()

Returns

Type	Description
BundleElement.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException