Class BundleElement (3.21.0)

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

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

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

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.

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

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException