Class BundleElement.Builder (3.20.0)

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BundleElement.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
BundleElement.Builder
Overrides

build()

public BundleElement build()
Returns
TypeDescription
BundleElement

buildPartial()

public BundleElement buildPartial()
Returns
TypeDescription
BundleElement

clear()

public BundleElement.Builder clear()
Returns
TypeDescription
BundleElement.Builder
Overrides

clearDocument()

public BundleElement.Builder clearDocument()

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

Returns
TypeDescription
BundleElement.Builder

clearDocumentMetadata()

public BundleElement.Builder clearDocumentMetadata()

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

Returns
TypeDescription
BundleElement.Builder

clearElementType()

public BundleElement.Builder clearElementType()
Returns
TypeDescription
BundleElement.Builder

clearField(Descriptors.FieldDescriptor field)

public BundleElement.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
BundleElement.Builder
Overrides

clearMetadata()

public BundleElement.Builder clearMetadata()

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

Returns
TypeDescription
BundleElement.Builder

clearNamedQuery()

public BundleElement.Builder clearNamedQuery()

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

Returns
TypeDescription
BundleElement.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public BundleElement.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
BundleElement.Builder
Overrides

clone()

public BundleElement.Builder clone()
Returns
TypeDescription
BundleElement.Builder
Overrides

getDefaultInstanceForType()

public BundleElement getDefaultInstanceForType()
Returns
TypeDescription
BundleElement

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDocument()

public Document getDocument()

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

Returns
TypeDescription
Document

The document.

getDocumentBuilder()

public Document.Builder getDocumentBuilder()

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

Returns
TypeDescription
Document.Builder

getDocumentMetadata()

public BundledDocumentMetadata getDocumentMetadata()

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

Returns
TypeDescription
BundledDocumentMetadata

The documentMetadata.

getDocumentMetadataBuilder()

public BundledDocumentMetadata.Builder getDocumentMetadataBuilder()

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

Returns
TypeDescription
BundledDocumentMetadata.Builder

getDocumentMetadataOrBuilder()

public BundledDocumentMetadataOrBuilder getDocumentMetadataOrBuilder()

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

Returns
TypeDescription
BundledDocumentMetadataOrBuilder

getDocumentOrBuilder()

public DocumentOrBuilder getDocumentOrBuilder()

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

Returns
TypeDescription
DocumentOrBuilder

getElementTypeCase()

public BundleElement.ElementTypeCase getElementTypeCase()
Returns
TypeDescription
BundleElement.ElementTypeCase

getMetadata()

public BundleMetadata getMetadata()

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

Returns
TypeDescription
BundleMetadata

The metadata.

getMetadataBuilder()

public BundleMetadata.Builder getMetadataBuilder()

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

Returns
TypeDescription
BundleMetadata.Builder

getMetadataOrBuilder()

public BundleMetadataOrBuilder getMetadataOrBuilder()

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

Returns
TypeDescription
BundleMetadataOrBuilder

getNamedQuery()

public NamedQuery getNamedQuery()

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

Returns
TypeDescription
NamedQuery

The namedQuery.

getNamedQueryBuilder()

public NamedQuery.Builder getNamedQueryBuilder()

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

Returns
TypeDescription
NamedQuery.Builder

getNamedQueryOrBuilder()

public NamedQueryOrBuilder getNamedQueryOrBuilder()

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

Returns
TypeDescription
NamedQueryOrBuilder

hasDocument()

public boolean hasDocument()

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

Returns
TypeDescription
boolean

Whether the document field is set.

hasDocumentMetadata()

public boolean hasDocumentMetadata()

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

Returns
TypeDescription
boolean

Whether the documentMetadata field is set.

hasMetadata()

public boolean hasMetadata()

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

Returns
TypeDescription
boolean

Whether the metadata field is set.

hasNamedQuery()

public boolean hasNamedQuery()

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

Returns
TypeDescription
boolean

Whether the namedQuery field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeDocument(Document value)

public BundleElement.Builder mergeDocument(Document value)

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

Parameter
NameDescription
valueDocument
Returns
TypeDescription
BundleElement.Builder

mergeDocumentMetadata(BundledDocumentMetadata value)

public BundleElement.Builder mergeDocumentMetadata(BundledDocumentMetadata value)

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

Parameter
NameDescription
valueBundledDocumentMetadata
Returns
TypeDescription
BundleElement.Builder

mergeFrom(BundleElement other)

public BundleElement.Builder mergeFrom(BundleElement other)
Parameter
NameDescription
otherBundleElement
Returns
TypeDescription
BundleElement.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BundleElement.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BundleElement.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public BundleElement.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
BundleElement.Builder
Overrides

mergeMetadata(BundleMetadata value)

public BundleElement.Builder mergeMetadata(BundleMetadata value)

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

Parameter
NameDescription
valueBundleMetadata
Returns
TypeDescription
BundleElement.Builder

mergeNamedQuery(NamedQuery value)

public BundleElement.Builder mergeNamedQuery(NamedQuery value)

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

Parameter
NameDescription
valueNamedQuery
Returns
TypeDescription
BundleElement.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BundleElement.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
BundleElement.Builder
Overrides

setDocument(Document value)

public BundleElement.Builder setDocument(Document value)

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

Parameter
NameDescription
valueDocument
Returns
TypeDescription
BundleElement.Builder

setDocument(Document.Builder builderForValue)

public BundleElement.Builder setDocument(Document.Builder builderForValue)

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

Parameter
NameDescription
builderForValueDocument.Builder
Returns
TypeDescription
BundleElement.Builder

setDocumentMetadata(BundledDocumentMetadata value)

public BundleElement.Builder setDocumentMetadata(BundledDocumentMetadata value)

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

Parameter
NameDescription
valueBundledDocumentMetadata
Returns
TypeDescription
BundleElement.Builder

setDocumentMetadata(BundledDocumentMetadata.Builder builderForValue)

public BundleElement.Builder setDocumentMetadata(BundledDocumentMetadata.Builder builderForValue)

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

Parameter
NameDescription
builderForValueBundledDocumentMetadata.Builder
Returns
TypeDescription
BundleElement.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public BundleElement.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
BundleElement.Builder
Overrides

setMetadata(BundleMetadata value)

public BundleElement.Builder setMetadata(BundleMetadata value)

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

Parameter
NameDescription
valueBundleMetadata
Returns
TypeDescription
BundleElement.Builder

setMetadata(BundleMetadata.Builder builderForValue)

public BundleElement.Builder setMetadata(BundleMetadata.Builder builderForValue)

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

Parameter
NameDescription
builderForValueBundleMetadata.Builder
Returns
TypeDescription
BundleElement.Builder

setNamedQuery(NamedQuery value)

public BundleElement.Builder setNamedQuery(NamedQuery value)

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

Parameter
NameDescription
valueNamedQuery
Returns
TypeDescription
BundleElement.Builder

setNamedQuery(NamedQuery.Builder builderForValue)

public BundleElement.Builder setNamedQuery(NamedQuery.Builder builderForValue)

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

Parameter
NameDescription
builderForValueNamedQuery.Builder
Returns
TypeDescription
BundleElement.Builder

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

public BundleElement.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
BundleElement.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final BundleElement.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
BundleElement.Builder
Overrides