Class BundleElement.Builder (3.21.1)

public static final class BundleElement.Builder extends GeneratedMessageV3.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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BundleElement.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BundleElement.Builder
Overrides

build()

public BundleElement build()
Returns
Type Description
BundleElement

buildPartial()

public BundleElement buildPartial()
Returns
Type Description
BundleElement

clear()

public BundleElement.Builder clear()
Returns
Type Description
BundleElement.Builder
Overrides

clearDocument()

public BundleElement.Builder clearDocument()

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

Returns
Type Description
BundleElement.Builder

clearDocumentMetadata()

public BundleElement.Builder clearDocumentMetadata()

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

Returns
Type Description
BundleElement.Builder

clearElementType()

public BundleElement.Builder clearElementType()
Returns
Type Description
BundleElement.Builder

clearField(Descriptors.FieldDescriptor field)

public BundleElement.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
BundleElement.Builder
Overrides

clearMetadata()

public BundleElement.Builder clearMetadata()

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

Returns
Type Description
BundleElement.Builder

clearNamedQuery()

public BundleElement.Builder clearNamedQuery()

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

Returns
Type Description
BundleElement.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public BundleElement.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
BundleElement.Builder
Overrides

clone()

public BundleElement.Builder clone()
Returns
Type Description
BundleElement.Builder
Overrides

getDefaultInstanceForType()

public BundleElement getDefaultInstanceForType()
Returns
Type Description
BundleElement

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
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;

Returns
Type Description
Document.Builder

getDocumentMetadata()

public BundledDocumentMetadata getDocumentMetadata()

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

Returns
Type Description
BundledDocumentMetadata

The documentMetadata.

getDocumentMetadataBuilder()

public BundledDocumentMetadata.Builder getDocumentMetadataBuilder()

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

Returns
Type Description
BundledDocumentMetadata.Builder

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.

getMetadataBuilder()

public BundleMetadata.Builder getMetadataBuilder()

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

Returns
Type Description
BundleMetadata.Builder

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.

getNamedQueryBuilder()

public NamedQuery.Builder getNamedQueryBuilder()

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

Returns
Type Description
NamedQuery.Builder

getNamedQueryOrBuilder()

public NamedQueryOrBuilder getNamedQueryOrBuilder()

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

Returns
Type Description
NamedQueryOrBuilder

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDocument(Document value)

public BundleElement.Builder mergeDocument(Document value)

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

Parameter
Name Description
value Document
Returns
Type Description
BundleElement.Builder

mergeDocumentMetadata(BundledDocumentMetadata value)

public BundleElement.Builder mergeDocumentMetadata(BundledDocumentMetadata value)

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

Parameter
Name Description
value BundledDocumentMetadata
Returns
Type Description
BundleElement.Builder

mergeFrom(BundleElement other)

public BundleElement.Builder mergeFrom(BundleElement other)
Parameter
Name Description
other BundleElement
Returns
Type Description
BundleElement.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BundleElement.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BundleElement.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public BundleElement.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
BundleElement.Builder
Overrides

mergeMetadata(BundleMetadata value)

public BundleElement.Builder mergeMetadata(BundleMetadata value)

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

Parameter
Name Description
value BundleMetadata
Returns
Type Description
BundleElement.Builder

mergeNamedQuery(NamedQuery value)

public BundleElement.Builder mergeNamedQuery(NamedQuery value)

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

Parameter
Name Description
value NamedQuery
Returns
Type Description
BundleElement.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BundleElement.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BundleElement.Builder
Overrides

setDocument(Document value)

public BundleElement.Builder setDocument(Document value)

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

Parameter
Name Description
value Document
Returns
Type Description
BundleElement.Builder

setDocument(Document.Builder builderForValue)

public BundleElement.Builder setDocument(Document.Builder builderForValue)

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

Parameter
Name Description
builderForValue Document.Builder
Returns
Type Description
BundleElement.Builder

setDocumentMetadata(BundledDocumentMetadata value)

public BundleElement.Builder setDocumentMetadata(BundledDocumentMetadata value)

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

Parameter
Name Description
value BundledDocumentMetadata
Returns
Type Description
BundleElement.Builder

setDocumentMetadata(BundledDocumentMetadata.Builder builderForValue)

public BundleElement.Builder setDocumentMetadata(BundledDocumentMetadata.Builder builderForValue)

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

Parameter
Name Description
builderForValue BundledDocumentMetadata.Builder
Returns
Type Description
BundleElement.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public BundleElement.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BundleElement.Builder
Overrides

setMetadata(BundleMetadata value)

public BundleElement.Builder setMetadata(BundleMetadata value)

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

Parameter
Name Description
value BundleMetadata
Returns
Type Description
BundleElement.Builder

setMetadata(BundleMetadata.Builder builderForValue)

public BundleElement.Builder setMetadata(BundleMetadata.Builder builderForValue)

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

Parameter
Name Description
builderForValue BundleMetadata.Builder
Returns
Type Description
BundleElement.Builder

setNamedQuery(NamedQuery value)

public BundleElement.Builder setNamedQuery(NamedQuery value)

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

Parameter
Name Description
value NamedQuery
Returns
Type Description
BundleElement.Builder

setNamedQuery(NamedQuery.Builder builderForValue)

public BundleElement.Builder setNamedQuery(NamedQuery.Builder builderForValue)

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

Parameter
Name Description
builderForValue NamedQuery.Builder
Returns
Type Description
BundleElement.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public BundleElement.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
BundleElement.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final BundleElement.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BundleElement.Builder
Overrides