Interface BatchGetDocumentsResponseOrBuilder (3.20.0)

public interface BatchGetDocumentsResponseOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFound()

public abstract Document getFound()

A document that was requested.

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

Returns
TypeDescription
Document

The found.

getFoundOrBuilder()

public abstract DocumentOrBuilder getFoundOrBuilder()

A document that was requested.

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

Returns
TypeDescription
DocumentOrBuilder

getMissing()

public abstract 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 abstract 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.

getReadTime()

public abstract 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 abstract 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 abstract BatchGetDocumentsResponse.ResultCase getResultCase()
Returns
TypeDescription
BatchGetDocumentsResponse.ResultCase

getTransaction()

public abstract 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.

hasFound()

public abstract boolean hasFound()

A document that was requested.

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

Returns
TypeDescription
boolean

Whether the found field is set.

hasMissing()

public abstract 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 abstract 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.