Class BundleMetadata (3.36.0) 

public final class BundleMetadata extends GeneratedMessage implements BundleMetadataOrBuilder

Metadata describing the bundle file/stream.

Protobuf type google.firestore.bundle.BundleMetadata

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > BundleMetadata

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

TOTAL_BYTES_FIELD_NUMBER

public static final int TOTAL_BYTES_FIELD_NUMBER
Field Value
Type Description
int

TOTAL_DOCUMENTS_FIELD_NUMBER

public static final int TOTAL_DOCUMENTS_FIELD_NUMBER
Field Value
Type Description
int

VERSION_FIELD_NUMBER

public static final int VERSION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BundleMetadata getDefaultInstance()
Returns
Type Description
BundleMetadata

getDescriptor()

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

newBuilder()

public static BundleMetadata.Builder newBuilder()
Returns
Type Description
BundleMetadata.Builder

newBuilder(BundleMetadata prototype)

public static BundleMetadata.Builder newBuilder(BundleMetadata prototype)
Parameter
Name Description
prototype BundleMetadata
Returns
Type Description
BundleMetadata.Builder

parseDelimitedFrom(InputStream input)

public static BundleMetadata parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BundleMetadata
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BundleMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BundleMetadata
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static BundleMetadata parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
BundleMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BundleMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BundleMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BundleMetadata parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
BundleMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BundleMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BundleMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BundleMetadata parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
BundleMetadata
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BundleMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BundleMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static BundleMetadata parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BundleMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BundleMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BundleMetadata
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static BundleMetadata parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
BundleMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BundleMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BundleMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<BundleMetadata> parser()
Returns
Type Description
Parser<BundleMetadata>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCreateTime()

public Timestamp getCreateTime()

Time at which the documents snapshot is taken for this bundle.

.google.protobuf.Timestamp create_time = 2;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Time at which the documents snapshot is taken for this bundle.

.google.protobuf.Timestamp create_time = 2;

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public BundleMetadata getDefaultInstanceForType()
Returns
Type Description
BundleMetadata

getId()

public String getId()

The ID of the bundle.

string id = 1;

Returns
Type Description
String

The id.

getIdBytes()

public ByteString getIdBytes()

The ID of the bundle.

string id = 1;

Returns
Type Description
ByteString

The bytes for id.

getParserForType()

public Parser<BundleMetadata> getParserForType()
Returns
Type Description
Parser<BundleMetadata>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTotalBytes()

public long getTotalBytes()

The size of the bundle in bytes, excluding this BundleMetadata.

uint64 total_bytes = 5;

Returns
Type Description
long

The totalBytes.

getTotalDocuments()

public int getTotalDocuments()

The number of documents in the bundle.

uint32 total_documents = 4;

Returns
Type Description
int

The totalDocuments.

getVersion()

public int getVersion()

The schema version of the bundle.

uint32 version = 3;

Returns
Type Description
int

The version.

hasCreateTime()

public boolean hasCreateTime()

Time at which the documents snapshot is taken for this bundle.

.google.protobuf.Timestamp create_time = 2;

Returns
Type Description
boolean

Whether the createTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public BundleMetadata.Builder newBuilderForType()
Returns
Type Description
BundleMetadata.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected BundleMetadata.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
BundleMetadata.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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