Send feedback
Class BundleElement.Builder (3.38.0)
Stay organized with collections
Save and categorize content based on your preferences.
3.38.0 (latest)
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 static final class BundleElement . Builder extends GeneratedMessage . Builder<BundleElement . Builder > 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.GeneratedMessage.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)
Static Methods
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Methods
build()
public BundleElement build ()
buildPartial()
public BundleElement buildPartial ()
clear()
public BundleElement . Builder clear ()
Overrides
clearDocument()
public BundleElement . Builder clearDocument ()
.google.firestore.v1.Document document = 4;
public BundleElement . Builder clearDocumentMetadata ()
.google.firestore.bundle.BundledDocumentMetadata document_metadata = 3;
clearElementType()
public BundleElement . Builder clearElementType ()
public BundleElement . Builder clearMetadata ()
.google.firestore.bundle.BundleMetadata metadata = 1;
clearNamedQuery()
public BundleElement . Builder clearNamedQuery ()
.google.firestore.bundle.NamedQuery named_query = 2;
getDefaultInstanceForType()
public BundleElement getDefaultInstanceForType ()
getDescriptorForType()
public Descriptors . Descriptor getDescriptorForType ()
Overrides
getDocument()
public Document getDocument ()
.google.firestore.v1.Document document = 4;
Returns
Type Description
Document The document.
getDocumentBuilder()
public Document . Builder getDocumentBuilder ()
.google.firestore.v1.Document document = 4;
public BundledDocumentMetadata getDocumentMetadata ()
.google.firestore.bundle.BundledDocumentMetadata document_metadata = 3;
public BundledDocumentMetadata . Builder getDocumentMetadataBuilder ()
.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 BundleMetadata . Builder getMetadataBuilder ()
.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.
getNamedQueryBuilder()
public NamedQuery . Builder getNamedQueryBuilder ()
.google.firestore.bundle.NamedQuery named_query = 2;
getNamedQueryOrBuilder()
public NamedQueryOrBuilder getNamedQueryOrBuilder ()
.google.firestore.bundle.NamedQuery named_query = 2;
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.
internalGetFieldAccessorTable()
protected GeneratedMessage . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
mergeDocument(Document value)
public BundleElement . Builder mergeDocument ( Document value )
.google.firestore.v1.Document document = 4;
Parameter
Name Description
valueDocument
public BundleElement . Builder mergeDocumentMetadata ( BundledDocumentMetadata value )
.google.firestore.bundle.BundledDocumentMetadata document_metadata = 3;
mergeFrom(BundleElement other)
public BundleElement . Builder mergeFrom ( BundleElement other )
public BundleElement . Builder mergeFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Overrides
mergeFrom(Message other)
public BundleElement . Builder mergeFrom ( Message other )
Parameter
Name Description
otherMessage
Overrides
public BundleElement . Builder mergeMetadata ( BundleMetadata value )
.google.firestore.bundle.BundleMetadata metadata = 1;
mergeNamedQuery(NamedQuery value)
public BundleElement . Builder mergeNamedQuery ( NamedQuery value )
.google.firestore.bundle.NamedQuery named_query = 2;
setDocument(Document value)
public BundleElement . Builder setDocument ( Document value )
.google.firestore.v1.Document document = 4;
Parameter
Name Description
valueDocument
setDocument(Document.Builder builderForValue)
public BundleElement . Builder setDocument ( Document . Builder builderForValue )
.google.firestore.v1.Document document = 4;
public BundleElement . Builder setDocumentMetadata ( BundledDocumentMetadata value )
.google.firestore.bundle.BundledDocumentMetadata document_metadata = 3;
public BundleElement . Builder setDocumentMetadata ( BundledDocumentMetadata . Builder builderForValue )
.google.firestore.bundle.BundledDocumentMetadata document_metadata = 3;
public BundleElement . Builder setMetadata ( BundleMetadata value )
.google.firestore.bundle.BundleMetadata metadata = 1;
public BundleElement . Builder setMetadata ( BundleMetadata . Builder builderForValue )
.google.firestore.bundle.BundleMetadata metadata = 1;
setNamedQuery(NamedQuery value)
public BundleElement . Builder setNamedQuery ( NamedQuery value )
.google.firestore.bundle.NamedQuery named_query = 2;
setNamedQuery(NamedQuery.Builder builderForValue)
public BundleElement . Builder setNamedQuery ( NamedQuery . Builder builderForValue )
.google.firestore.bundle.NamedQuery named_query = 2;
Send feedback
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-03-14 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-03-14 UTC."],[],[]]
