Class BundleMetadata (3.3.0)

public final class BundleMetadata extends GeneratedMessageV3 implements BundleMetadataOrBuilder

Metadata describing the bundle file/stream.

Protobuf type google.firestore.bundle.BundleMetadata

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
TypeDescription
int

TOTAL_BYTES_FIELD_NUMBER

public static final int TOTAL_BYTES_FIELD_NUMBER
Field Value
TypeDescription
int

TOTAL_DOCUMENTS_FIELD_NUMBER

public static final int TOTAL_DOCUMENTS_FIELD_NUMBER
Field Value
TypeDescription
int

VERSION_FIELD_NUMBER

public static final int VERSION_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static BundleMetadata getDefaultInstance()
Returns
TypeDescription
BundleMetadata

getDescriptor()

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

newBuilder()

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

newBuilder(BundleMetadata prototype)

public static BundleMetadata.Builder newBuilder(BundleMetadata prototype)
Parameter
NameDescription
prototypeBundleMetadata
Returns
TypeDescription
BundleMetadata.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCreateTime()

public Timestamp getCreateTime()

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

.google.protobuf.Timestamp create_time = 2;

Returns
TypeDescription
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
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public BundleMetadata getDefaultInstanceForType()
Returns
TypeDescription
BundleMetadata

getId()

public String getId()

The ID of the bundle.

string id = 1;

Returns
TypeDescription
String

The id.

getIdBytes()

public ByteString getIdBytes()

The ID of the bundle.

string id = 1;

Returns
TypeDescription
ByteString

The bytes for id.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTotalBytes()

public long getTotalBytes()

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

uint64 total_bytes = 5;

Returns
TypeDescription
long

The totalBytes.

getTotalDocuments()

public int getTotalDocuments()

The number of documents in the bundle.

uint32 total_documents = 4;

Returns
TypeDescription
int

The totalDocuments.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getVersion()

public int getVersion()

The schema version of the bundle.

uint32 version = 3;

Returns
TypeDescription
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
TypeDescription
boolean

Whether the createTime 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 BundleMetadata.Builder newBuilderForType()
Returns
TypeDescription
BundleMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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