com.google.firestore.v1

Class BatchGetDocumentsResponse

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.firestore.v1.BatchGetDocumentsResponse

All Implemented Interfaces:

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

public final class BatchGetDocumentsResponse
extends com.google.protobuf.GeneratedMessageV3
implements BatchGetDocumentsResponseOrBuilder

 The streamed response for
 [Firestore.BatchGetDocuments][google.firestore.v1.Firestore.BatchGetDocuments].
 

Protobuf type google.firestore.v1.BatchGetDocumentsResponse

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BatchGetDocumentsResponse.Builder The streamed response for [Firestore.BatchGetDocuments][google.firestore.v1.Firestore.BatchGetDocuments].
static class	BatchGetDocumentsResponse.ResultCase

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, 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	FOUND_FIELD_NUMBER
static int	MISSING_FIELD_NUMBER
static int	READ_TIME_FIELD_NUMBER
static int	TRANSACTION_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 BatchGetDocumentsResponse	getDefaultInstance()
BatchGetDocumentsResponse	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Document	getFound() A document that was requested.
DocumentOrBuilder	getFoundOrBuilder() A document that was requested.
String	getMissing() A document name that was requested but does not exist.
com.google.protobuf.ByteString	getMissingBytes() A document name that was requested but does not exist.
com.google.protobuf.Parser<BatchGetDocumentsResponse>	getParserForType()
com.google.protobuf.Timestamp	getReadTime() The time at which the document was read.
com.google.protobuf.TimestampOrBuilder	getReadTimeOrBuilder() The time at which the document was read.
BatchGetDocumentsResponse.ResultCase	getResultCase()
int	getSerializedSize()
com.google.protobuf.ByteString	getTransaction() The transaction that was started as part of this request.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasFound() A document that was requested.
int	hashCode()
boolean	hasMissing() A document name that was requested but does not exist.
boolean	hasReadTime() The time at which the document was read.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static BatchGetDocumentsResponse.Builder	newBuilder()
static BatchGetDocumentsResponse.Builder	newBuilder(BatchGetDocumentsResponse prototype)
BatchGetDocumentsResponse.Builder	newBuilderForType()
protected BatchGetDocumentsResponse.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static BatchGetDocumentsResponse	parseDelimitedFrom(InputStream input)
static BatchGetDocumentsResponse	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchGetDocumentsResponse	parseFrom(byte[] data)
static BatchGetDocumentsResponse	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchGetDocumentsResponse	parseFrom(ByteBuffer data)
static BatchGetDocumentsResponse	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchGetDocumentsResponse	parseFrom(com.google.protobuf.ByteString data)
static BatchGetDocumentsResponse	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchGetDocumentsResponse	parseFrom(com.google.protobuf.CodedInputStream input)
static BatchGetDocumentsResponse	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchGetDocumentsResponse	parseFrom(InputStream input)
static BatchGetDocumentsResponse	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<BatchGetDocumentsResponse>	parser()
BatchGetDocumentsResponse.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, makeMutableCopy, 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

FOUND_FIELD_NUMBER

public static final int FOUND_FIELD_NUMBER

See Also:

Constant Field Values

MISSING_FIELD_NUMBER

public static final int MISSING_FIELD_NUMBER

See Also:

Constant Field Values

TRANSACTION_FIELD_NUMBER

public static final int TRANSACTION_FIELD_NUMBER

See Also:

Constant Field Values

READ_TIME_FIELD_NUMBER

public static final int READ_TIME_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

getResultCase

public BatchGetDocumentsResponse.ResultCase getResultCase()

Specified by:

getResultCase in interface BatchGetDocumentsResponseOrBuilder

hasFound

public boolean hasFound()

 A document that was requested.
 

.google.firestore.v1.Document found = 1;

Specified by:

hasFound in interface BatchGetDocumentsResponseOrBuilder

Returns:

Whether the found field is set.

getFound

public Document getFound()

 A document that was requested.
 

.google.firestore.v1.Document found = 1;

Specified by:

getFound in interface BatchGetDocumentsResponseOrBuilder

Returns:

The found.

getFoundOrBuilder

public DocumentOrBuilder getFoundOrBuilder()

 A document that was requested.
 

.google.firestore.v1.Document found = 1;

Specified by:

getFoundOrBuilder in interface BatchGetDocumentsResponseOrBuilder

hasMissing

public boolean hasMissing()

 A document name that was requested but does not exist. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 

string missing = 2;

Specified by:

hasMissing in interface BatchGetDocumentsResponseOrBuilder

Returns:

Whether the missing field is set.

getMissing

public String getMissing()

 A document name that was requested but does not exist. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 

string missing = 2;

Specified by:

getMissing in interface BatchGetDocumentsResponseOrBuilder

Returns:

The missing.

getMissingBytes

public com.google.protobuf.ByteString getMissingBytes()

 A document name that was requested but does not exist. In the format:
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 

string missing = 2;

Specified by:

getMissingBytes in interface BatchGetDocumentsResponseOrBuilder

Returns:

The bytes for missing.

getTransaction

public com.google.protobuf.ByteString getTransaction()

 The transaction that was started as part of this request.
 Will only be set in the first response, and only if
 [BatchGetDocumentsRequest.new_transaction][google.firestore.v1.BatchGetDocumentsRequest.new_transaction]
 was set in the request.
 

bytes transaction = 3;

Specified by:

getTransaction in interface BatchGetDocumentsResponseOrBuilder

Returns:

The transaction.

hasReadTime

public boolean hasReadTime()

 The time at which the document was read.
 This may be monotically increasing, in this case the previous documents in
 the result stream are guaranteed not to have changed between their
 read_time and this one.
 

.google.protobuf.Timestamp read_time = 4;

Specified by:

hasReadTime in interface BatchGetDocumentsResponseOrBuilder

Returns:

Whether the readTime field is set.

getReadTime

public com.google.protobuf.Timestamp getReadTime()

 The time at which the document was read.
 This may be monotically increasing, in this case the previous documents in
 the result stream are guaranteed not to have changed between their
 read_time and this one.
 

.google.protobuf.Timestamp read_time = 4;

Specified by:

getReadTime in interface BatchGetDocumentsResponseOrBuilder

Returns:

The readTime.

getReadTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getReadTimeOrBuilder()

 The time at which the document was read.
 This may be monotically increasing, in this case the previous documents in
 the result stream are guaranteed not to have changed between their
 read_time and this one.
 

.google.protobuf.Timestamp read_time = 4;

Specified by:

getReadTimeOrBuilder in interface BatchGetDocumentsResponseOrBuilder

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 BatchGetDocumentsResponse parseFrom(ByteBuffer data)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BatchGetDocumentsResponse parseFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static BatchGetDocumentsResponse parseDelimitedFrom(InputStream input)
                                                    throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public BatchGetDocumentsResponse.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static BatchGetDocumentsResponse.Builder newBuilder()

newBuilder

public static BatchGetDocumentsResponse.Builder newBuilder(BatchGetDocumentsResponse prototype)

toBuilder

public BatchGetDocumentsResponse.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static BatchGetDocumentsResponse getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<BatchGetDocumentsResponse> 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 BatchGetDocumentsResponse getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder