Send feedback
Class BatchGetDocumentsResponse (3.4.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.4.0 keyboard_arrow_down
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
MISSING_FIELD_NUMBER
public static final int MISSING_FIELD_NUMBER
Field Value
READ_TIME_FIELD_NUMBER
public static final int READ_TIME_FIELD_NUMBER
Field Value
TRANSACTION_FIELD_NUMBER
public static final int TRANSACTION_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static BatchGetDocumentsResponse getDefaultInstance ()
Returns
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
newBuilder()
public static BatchGetDocumentsResponse . Builder newBuilder ()
Returns
newBuilder(BatchGetDocumentsResponse prototype)
public static BatchGetDocumentsResponse . Builder newBuilder ( BatchGetDocumentsResponse prototype )
Parameter
Returns
public static BatchGetDocumentsResponse parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static BatchGetDocumentsResponse parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static BatchGetDocumentsResponse parseFrom ( byte [] data )
Parameter
Name Description data byte []
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static BatchGetDocumentsResponse parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static BatchGetDocumentsResponse parseFrom ( ByteString data )
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BatchGetDocumentsResponse parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static BatchGetDocumentsResponse parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static BatchGetDocumentsResponse parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static BatchGetDocumentsResponse parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static BatchGetDocumentsResponse parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static BatchGetDocumentsResponse parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static BatchGetDocumentsResponse parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parser()
public static Parser<BatchGetDocumentsResponse> parser ()
Returns
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Returns
Overrides
getDefaultInstanceForType()
public BatchGetDocumentsResponse getDefaultInstanceForType ()
Returns
getFound()
public Document getFound ()
A document that was requested.
.google.firestore.v1.Document found = 1;
Returns
getFoundOrBuilder()
public DocumentOrBuilder getFoundOrBuilder ()
A document that was requested.
.google.firestore.v1.Document found = 1;
Returns
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
getParserForType()
public Parser<BatchGetDocumentsResponse> getParserForType ()
Returns
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
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
getResultCase()
public BatchGetDocumentsResponse . ResultCase getResultCase ()
Returns
getSerializedSize()
public int getSerializedSize ()
Returns
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
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
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()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
newBuilderForType()
public BatchGetDocumentsResponse . Builder newBuilderForType ()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected BatchGetDocumentsResponse . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
toBuilder()
public BatchGetDocumentsResponse . Builder toBuilder ()
Returns
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-27 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-27 UTC."],[],[]]
