Class BundleElement (3.6.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
TypeDescription
int

DOCUMENT_METADATA_FIELD_NUMBER

public static final int DOCUMENT_METADATA_FIELD_NUMBER
Field Value
TypeDescription
int

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
TypeDescription
int

NAMED_QUERY_FIELD_NUMBER

public static final int NAMED_QUERY_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static BundleElement getDefaultInstance()
Returns
TypeDescription
BundleElement

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static BundleElement.Builder newBuilder()
Returns
TypeDescription
BundleElement.Builder

newBuilder(BundleElement prototype)

public static BundleElement.Builder newBuilder(BundleElement prototype)
Parameter
NameDescription
prototypeBundleElement
Returns
TypeDescription
BundleElement.Builder

parseDelimitedFrom(InputStream input)

public static BundleElement parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
BundleElement
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BundleElement parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BundleElement
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static BundleElement parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
BundleElement
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BundleElement parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BundleElement
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BundleElement parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
BundleElement
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BundleElement parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BundleElement
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BundleElement parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
BundleElement
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BundleElement parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BundleElement
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static BundleElement parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
BundleElement
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BundleElement parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BundleElement
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static BundleElement parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
BundleElement
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BundleElement parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BundleElement
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<BundleElement> parser()
Returns
TypeDescription
Parser<BundleElement>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public BundleElement getDefaultInstanceForType()
Returns
TypeDescription
BundleElement

getDocument()

public Document getDocument()

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

Returns
TypeDescription
Document

The document.

getDocumentMetadata()

public BundledDocumentMetadata getDocumentMetadata()

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

Returns
TypeDescription
BundledDocumentMetadata

The documentMetadata.

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.

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.

getNamedQueryOrBuilder()

public NamedQueryOrBuilder getNamedQueryOrBuilder()

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

Returns
TypeDescription
NamedQueryOrBuilder

getParserForType()

public Parser<BundleElement> getParserForType()
Returns
TypeDescription
Parser<BundleElement>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BundleElement.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
BundleElement.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException