Class BatchGetDocumentsResponse (3.21.0)

Version 3.21.0

• 3.30.0 (latest)
• 3.28.0
• 3.27.2
• 3.26.5
• 3.25.1
• 3.24.3
• 3.22.0
• 3.21.4
• 3.20.0
• 3.17.0
• 3.16.3
• 3.15.7
• 3.14.4
• 3.13.2
• 3.12.1
• 3.11.0
• 3.10.0
• 3.9.6
• 3.8.2
• 3.7.10
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.21

public final class BatchGetDocumentsResponse extends GeneratedMessageV3 implements BatchGetDocumentsResponseOrBuilder

The streamed response for Firestore.BatchGetDocuments.

Protobuf type google.firestore.v1.BatchGetDocumentsResponse

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > BatchGetDocumentsResponse

Implements

BatchGetDocumentsResponseOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

FOUND_FIELD_NUMBER

public static final int FOUND_FIELD_NUMBER

Field Value
Type	Description
int

MISSING_FIELD_NUMBER

public static final int MISSING_FIELD_NUMBER

Field Value
Type	Description
int

READ_TIME_FIELD_NUMBER

public static final int READ_TIME_FIELD_NUMBER

Field Value
Type	Description
int

TRANSACTION_FIELD_NUMBER

public static final int TRANSACTION_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static BatchGetDocumentsResponse getDefaultInstance()

Returns
Type	Description
BatchGetDocumentsResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static BatchGetDocumentsResponse.Builder newBuilder()

Returns
Type	Description
BatchGetDocumentsResponse.Builder

newBuilder(BatchGetDocumentsResponse prototype)

public static BatchGetDocumentsResponse.Builder newBuilder(BatchGetDocumentsResponse prototype)

Parameter
Name	Description
prototype	BatchGetDocumentsResponse

Returns
Type	Description
BatchGetDocumentsResponse.Builder

parseDelimitedFrom(InputStream input)

public static BatchGetDocumentsResponse parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
BatchGetDocumentsResponse

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchGetDocumentsResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BatchGetDocumentsResponse

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static BatchGetDocumentsResponse parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
BatchGetDocumentsResponse

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BatchGetDocumentsResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BatchGetDocumentsResponse

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BatchGetDocumentsResponse parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
BatchGetDocumentsResponse

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BatchGetDocumentsResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BatchGetDocumentsResponse

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BatchGetDocumentsResponse parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
BatchGetDocumentsResponse

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchGetDocumentsResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BatchGetDocumentsResponse

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static BatchGetDocumentsResponse parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
BatchGetDocumentsResponse

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchGetDocumentsResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BatchGetDocumentsResponse

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static BatchGetDocumentsResponse parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
BatchGetDocumentsResponse

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BatchGetDocumentsResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BatchGetDocumentsResponse

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<BatchGetDocumentsResponse> parser()

Returns
Type	Description
Parser<BatchGetDocumentsResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public BatchGetDocumentsResponse getDefaultInstanceForType()

Returns
Type	Description
BatchGetDocumentsResponse

getFound()

public Document getFound()

A document that was requested.

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

Returns
Type	Description
Document	The found.

getFoundOrBuilder()

public DocumentOrBuilder getFoundOrBuilder()

A document that was requested.

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

Returns
Type	Description
DocumentOrBuilder

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;

Returns
Type	Description
String	The missing.

getMissingBytes()

public 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;

Returns
Type	Description
ByteString	The bytes for missing.

getParserForType()

public Parser<BatchGetDocumentsResponse> getParserForType()

Returns
Type	Description
Parser<BatchGetDocumentsResponse>

Overrides

GeneratedMessageV3.getParserForType()

getReadTime()

public 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;

Returns
Type	Description
Timestamp	The readTime.

getReadTimeOrBuilder()

public 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;

Returns
Type	Description
TimestampOrBuilder

getResultCase()

public BatchGetDocumentsResponse.ResultCase getResultCase()

Returns
Type	Description
BatchGetDocumentsResponse.ResultCase

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getTransaction()

public 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 was set in the request.

bytes transaction = 3;

Returns
Type	Description
ByteString	The transaction.

hasFound()

public boolean hasFound()

A document that was requested.

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

Returns
Type	Description
boolean	Whether the found field is set.

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;

Returns
Type	Description
boolean	Whether the missing field is set.

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;

Returns
Type	Description
boolean	Whether the readTime field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public BatchGetDocumentsResponse.Builder newBuilderForType()

Returns
Type	Description
BatchGetDocumentsResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BatchGetDocumentsResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
BatchGetDocumentsResponse.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public BatchGetDocumentsResponse.Builder toBuilder()

Returns
Type	Description
BatchGetDocumentsResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException