com.google.firestore.bundle

Class BundledDocumentMetadata

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.firestore.bundle.BundledDocumentMetadata

All Implemented Interfaces:

BundledDocumentMetadataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class BundledDocumentMetadata
extends com.google.protobuf.GeneratedMessageV3
implements BundledDocumentMetadataOrBuilder

 Metadata describing a Firestore document saved in the bundle.
 

Protobuf type google.firestore.bundle.BundledDocumentMetadata

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BundledDocumentMetadata.Builder Metadata describing a Firestore document saved in the bundle.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	EXISTS_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	QUERIES_FIELD_NUMBER
static int	READ_TIME_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static BundledDocumentMetadata	getDefaultInstance()
BundledDocumentMetadata	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getExists() Whether the document exists.
String	getName() The document key of a bundled document.
com.google.protobuf.ByteString	getNameBytes() The document key of a bundled document.
com.google.protobuf.Parser<BundledDocumentMetadata>	getParserForType()
String	getQueries(int index) The names of the queries in this bundle that this document matches to.
com.google.protobuf.ByteString	getQueriesBytes(int index) The names of the queries in this bundle that this document matches to.
int	getQueriesCount() The names of the queries in this bundle that this document matches to.
com.google.protobuf.ProtocolStringList	getQueriesList() The names of the queries in this bundle that this document matches to.
com.google.protobuf.Timestamp	getReadTime() The snapshot version of the document data bundled.
com.google.protobuf.TimestampOrBuilder	getReadTimeOrBuilder() The snapshot version of the document data bundled.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasReadTime() The snapshot version of the document data bundled.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static BundledDocumentMetadata.Builder	newBuilder()
static BundledDocumentMetadata.Builder	newBuilder(BundledDocumentMetadata prototype)
BundledDocumentMetadata.Builder	newBuilderForType()
protected BundledDocumentMetadata.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static BundledDocumentMetadata	parseDelimitedFrom(InputStream input)
static BundledDocumentMetadata	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BundledDocumentMetadata	parseFrom(byte[] data)
static BundledDocumentMetadata	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BundledDocumentMetadata	parseFrom(ByteBuffer data)
static BundledDocumentMetadata	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BundledDocumentMetadata	parseFrom(com.google.protobuf.ByteString data)
static BundledDocumentMetadata	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BundledDocumentMetadata	parseFrom(com.google.protobuf.CodedInputStream input)
static BundledDocumentMetadata	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BundledDocumentMetadata	parseFrom(InputStream input)
static BundledDocumentMetadata	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<BundledDocumentMetadata>	parser()
BundledDocumentMetadata.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

READ_TIME_FIELD_NUMBER

public static final int READ_TIME_FIELD_NUMBER

See Also:

Constant Field Values

EXISTS_FIELD_NUMBER

public static final int EXISTS_FIELD_NUMBER

See Also:

Constant Field Values

QUERIES_FIELD_NUMBER

public static final int QUERIES_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName

public String getName()

 The document key of a bundled document.
 

string name = 1;

Specified by:

getName in interface BundledDocumentMetadataOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 The document key of a bundled document.
 

string name = 1;

Specified by:

getNameBytes in interface BundledDocumentMetadataOrBuilder

Returns:

The bytes for name.

hasReadTime

public boolean hasReadTime()

 The snapshot version of the document data bundled.
 

.google.protobuf.Timestamp read_time = 2;

Specified by:

hasReadTime in interface BundledDocumentMetadataOrBuilder

Returns:

Whether the readTime field is set.

getReadTime

public com.google.protobuf.Timestamp getReadTime()

 The snapshot version of the document data bundled.
 

.google.protobuf.Timestamp read_time = 2;

Specified by:

getReadTime in interface BundledDocumentMetadataOrBuilder

Returns:

The readTime.

getReadTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getReadTimeOrBuilder()

 The snapshot version of the document data bundled.
 

.google.protobuf.Timestamp read_time = 2;

Specified by:

getReadTimeOrBuilder in interface BundledDocumentMetadataOrBuilder

getExists

public boolean getExists()

 Whether the document exists.
 

bool exists = 3;

Specified by:

getExists in interface BundledDocumentMetadataOrBuilder

Returns:

The exists.

getQueriesList

public com.google.protobuf.ProtocolStringList getQueriesList()

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

repeated string queries = 4;

Specified by:

getQueriesList in interface BundledDocumentMetadataOrBuilder

Returns:

A list containing the queries.

getQueriesCount

public int getQueriesCount()

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

repeated string queries = 4;

Specified by:

getQueriesCount in interface BundledDocumentMetadataOrBuilder

Returns:

The count of queries.

getQueries

public String getQueries(int index)

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

repeated string queries = 4;

Specified by:

getQueries in interface BundledDocumentMetadataOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The queries at the given index.

getQueriesBytes

public com.google.protobuf.ByteString getQueriesBytes(int index)

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

repeated string queries = 4;

Specified by:

getQueriesBytes in interface BundledDocumentMetadataOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the queries at the given index.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static BundledDocumentMetadata parseFrom(ByteBuffer data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BundledDocumentMetadata parseFrom(ByteBuffer data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BundledDocumentMetadata parseFrom(com.google.protobuf.ByteString data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BundledDocumentMetadata parseFrom(com.google.protobuf.ByteString data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BundledDocumentMetadata parseFrom(byte[] data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BundledDocumentMetadata parseFrom(byte[] data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BundledDocumentMetadata parseFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseFrom

public static BundledDocumentMetadata parseFrom(InputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static BundledDocumentMetadata parseDelimitedFrom(InputStream input)
                                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static BundledDocumentMetadata parseDelimitedFrom(InputStream input,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws IOException

Throws:

IOException

parseFrom

public static BundledDocumentMetadata parseFrom(com.google.protobuf.CodedInputStream input)
                                         throws IOException

Throws:

IOException

parseFrom

public static BundledDocumentMetadata parseFrom(com.google.protobuf.CodedInputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

newBuilderForType

public BundledDocumentMetadata.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static BundledDocumentMetadata.Builder newBuilder()

newBuilder

public static BundledDocumentMetadata.Builder newBuilder(BundledDocumentMetadata prototype)

toBuilder

public BundledDocumentMetadata.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected BundledDocumentMetadata.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static BundledDocumentMetadata getDefaultInstance()

parser

public static com.google.protobuf.Parser<BundledDocumentMetadata> parser()

getParserForType

public com.google.protobuf.Parser<BundledDocumentMetadata> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public BundledDocumentMetadata getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder