Class BatchGetDocumentsResponse (3.11.0)

public final class BatchGetDocumentsResponse extends GeneratedMessageV3 implements BatchGetDocumentsResponseOrBuilder

The streamed response for Firestore.BatchGetDocuments.

Protobuf type google.firestore.v1.BatchGetDocumentsResponse

Static Fields

FOUND_FIELD_NUMBER

public static final int FOUND_FIELD_NUMBER
Field Value
TypeDescription
int

MISSING_FIELD_NUMBER

public static final int MISSING_FIELD_NUMBER
Field Value
TypeDescription
int

READ_TIME_FIELD_NUMBER

public static final int READ_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

TRANSACTION_FIELD_NUMBER

public static final int TRANSACTION_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static BatchGetDocumentsResponse getDefaultInstance()
Returns
TypeDescription
BatchGetDocumentsResponse

getDescriptor()

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

newBuilder()

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

newBuilder(BatchGetDocumentsResponse prototype)

public static BatchGetDocumentsResponse.Builder newBuilder(BatchGetDocumentsResponse prototype)
Parameter
NameDescription
prototypeBatchGetDocumentsResponse
Returns
TypeDescription
BatchGetDocumentsResponse.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public BatchGetDocumentsResponse getDefaultInstanceForType()
Returns
TypeDescription
BatchGetDocumentsResponse

getFound()

public Document getFound()

A document that was requested.

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

Returns
TypeDescription
Document

The found.

getFoundOrBuilder()

public DocumentOrBuilder getFoundOrBuilder()

A document that was requested.

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

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

The bytes for missing.

getParserForType()

public Parser<BatchGetDocumentsResponse> getParserForType()
Returns
TypeDescription
Parser<BatchGetDocumentsResponse>
Overrides

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

getResultCase()

public BatchGetDocumentsResponse.ResultCase getResultCase()
Returns
TypeDescription
BatchGetDocumentsResponse.ResultCase

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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

The transaction.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasFound()

public boolean hasFound()

A document that was requested.

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

Returns
TypeDescription
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
TypeDescription
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
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 BatchGetDocumentsResponse.Builder newBuilderForType()
Returns
TypeDescription
BatchGetDocumentsResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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