Class BundledDocumentMetadata (3.21.4)

public final class BundledDocumentMetadata extends GeneratedMessageV3 implements BundledDocumentMetadataOrBuilder

Metadata describing a Firestore document saved in the bundle.

Protobuf type google.firestore.bundle.BundledDocumentMetadata

Static Fields

EXISTS_FIELD_NUMBER

public static final int EXISTS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

QUERIES_FIELD_NUMBER

public static final int QUERIES_FIELD_NUMBER
Field Value
Type Description
int

READ_TIME_FIELD_NUMBER

public static final int READ_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BundledDocumentMetadata getDefaultInstance()
Returns
Type Description
BundledDocumentMetadata

getDescriptor()

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

newBuilder()

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

newBuilder(BundledDocumentMetadata prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public BundledDocumentMetadata getDefaultInstanceForType()
Returns
Type Description
BundledDocumentMetadata

getExists()

public boolean getExists()

Whether the document exists.

bool exists = 3;

Returns
Type Description
boolean

The exists.

getName()

public String getName()

The document key of a bundled document.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The document key of a bundled document.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getQueries(int index)

public String getQueries(int index)

The names of the queries in this bundle that this document matches to.

repeated string queries = 4;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The queries at the given index.

getQueriesBytes(int index)

public ByteString getQueriesBytes(int index)

The names of the queries in this bundle that this document matches to.

repeated string queries = 4;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the queries at the given index.

getQueriesCount()

public int getQueriesCount()

The names of the queries in this bundle that this document matches to.

repeated string queries = 4;

Returns
Type Description
int

The count of queries.

getQueriesList()

public ProtocolStringList getQueriesList()

The names of the queries in this bundle that this document matches to.

repeated string queries = 4;

Returns
Type Description
ProtocolStringList

A list containing the queries.

getReadTime()

public Timestamp getReadTime()

The snapshot version of the document data bundled.

.google.protobuf.Timestamp read_time = 2;

Returns
Type Description
Timestamp

The readTime.

getReadTimeOrBuilder()

public TimestampOrBuilder getReadTimeOrBuilder()

The snapshot version of the document data bundled.

.google.protobuf.Timestamp read_time = 2;

Returns
Type Description
TimestampOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasReadTime()

public boolean hasReadTime()

The snapshot version of the document data bundled.

.google.protobuf.Timestamp read_time = 2;

Returns
Type Description
boolean

Whether the readTime 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 BundledDocumentMetadata.Builder newBuilderForType()
Returns
Type Description
BundledDocumentMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BundledDocumentMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
BundledDocumentMetadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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