Class BundleElement (3.31.9)
3.41.0 (latest)
3.38.0
3.37.0
3.36.0
3.35.1
3.33.4
3.32.2
3.31.9
3.30.11
3.28.0
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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
DOCUMENT_FIELD_NUMBER
public static final int DOCUMENT_FIELD_NUMBER
Field Value
Type
Description
int
public static final int DOCUMENT_METADATA_FIELD_NUMBER
Field Value
Type
Description
int
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 ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static BundleElement . Builder newBuilder ()
newBuilder(BundleElement prototype)
public static BundleElement . Builder newBuilder ( BundleElement prototype )
public static BundleElement parseDelimitedFrom ( InputStream input )
public static BundleElement parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static BundleElement parseFrom ( byte [] data )
Parameter
Name
Description
data
byte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static BundleElement parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static BundleElement parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BundleElement parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static BundleElement parseFrom ( CodedInputStream input )
public static BundleElement parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static BundleElement parseFrom ( InputStream input )
public static BundleElement parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static BundleElement parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static BundleElement parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<BundleElement> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name
Description
obj
Object
Overrides
getDefaultInstanceForType()
public BundleElement getDefaultInstanceForType ()
getDocument()
public Document getDocument ()
.google.firestore.v1.Document document = 4;
Returns
Type
Description
Document
The document.
public BundledDocumentMetadata getDocumentMetadata ()
.google.firestore.bundle.BundledDocumentMetadata document_metadata = 3;
public BundledDocumentMetadataOrBuilder getDocumentMetadataOrBuilder ()
.google.firestore.bundle.BundledDocumentMetadata document_metadata = 3;
getDocumentOrBuilder()
public DocumentOrBuilder getDocumentOrBuilder ()
.google.firestore.v1.Document document = 4;
getElementTypeCase()
public BundleElement . ElementTypeCase getElementTypeCase ()
public BundleMetadata getMetadata ()
.google.firestore.bundle.BundleMetadata metadata = 1;
public BundleMetadataOrBuilder getMetadataOrBuilder ()
.google.firestore.bundle.BundleMetadata metadata = 1;
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;
getParserForType()
public Parser<BundleElement> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type
Description
int
Overrides
hasDocument()
public boolean hasDocument ()
.google.firestore.v1.Document document = 4;
Returns
Type
Description
boolean
Whether the document field is set.
public boolean hasDocumentMetadata ()
.google.firestore.bundle.BundledDocumentMetadata document_metadata = 3;
Returns
Type
Description
boolean
Whether the documentMetadata field is set.
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()
Returns
Type
Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public BundleElement . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected BundleElement . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type
Description
Object
Overrides
toBuilder()
public BundleElement . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-04-25 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-04-25 UTC."],[],[]]