Class BundledDocumentMetadata (3.5.0)

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
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

QUERIES_FIELD_NUMBER

public static final int QUERIES_FIELD_NUMBER
Field Value
TypeDescription
int

READ_TIME_FIELD_NUMBER

public static final int READ_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static BundledDocumentMetadata getDefaultInstance()
Returns
TypeDescription
BundledDocumentMetadata

getDescriptor()

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

newBuilder()

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

newBuilder(BundledDocumentMetadata prototype)

public static BundledDocumentMetadata.Builder newBuilder(BundledDocumentMetadata prototype)
Parameter
NameDescription
prototypeBundledDocumentMetadata
Returns
TypeDescription
BundledDocumentMetadata.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public BundledDocumentMetadata getDefaultInstanceForType()
Returns
TypeDescription
BundledDocumentMetadata

getExists()

public boolean getExists()

Whether the document exists.

bool exists = 3;

Returns
TypeDescription
boolean

The exists.

getName()

public String getName()

The document key of a bundled document.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

The document key of a bundled document.

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<BundledDocumentMetadata> getParserForType()
Returns
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

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

The readTime.

getReadTimeOrBuilder()

public TimestampOrBuilder getReadTimeOrBuilder()

The snapshot version of the document data bundled.

.google.protobuf.Timestamp read_time = 2;

Returns
TypeDescription
TimestampOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasReadTime()

public boolean hasReadTime()

The snapshot version of the document data bundled.

.google.protobuf.Timestamp read_time = 2;

Returns
TypeDescription
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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