public final class BatchGetDocumentsResponse extends GeneratedMessageV3 implements BatchGetDocumentsResponseOrBuilderThe streamed response for Firestore.BatchGetDocuments.
Protobuf type google.firestore.v1.BatchGetDocumentsResponse
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > BatchGetDocumentsResponseImplements
BatchGetDocumentsResponseOrBuilderStatic 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 |
|
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> |
|
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 |
|
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 |
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused |
UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object |
|
toBuilder()
public BatchGetDocumentsResponse.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
BatchGetDocumentsResponse.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|