Interface RunQueryResponseOrBuilder

public interface RunQueryResponseOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDocument()

public abstract Document getDocument()

A query result. Not set when reporting partial progress.

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

Returns
TypeDescription
Document

The document.

getDocumentOrBuilder()

public abstract DocumentOrBuilder getDocumentOrBuilder()

A query result. Not set when reporting partial progress.

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

Returns
TypeDescription
DocumentOrBuilder

getReadTime()

public abstract Timestamp getReadTime()

The time at which the document was read. This may be monotonically increasing; in this case, the previous documents in the result stream are guaranteed not to have changed between their read_time and this one. If the query returns no results, a response with read_time and no document will be sent, and this represents the time at which the query was run.

.google.protobuf.Timestamp read_time = 3;

Returns
TypeDescription
Timestamp

The readTime.

getReadTimeOrBuilder()

public abstract TimestampOrBuilder getReadTimeOrBuilder()

The time at which the document was read. This may be monotonically increasing; in this case, the previous documents in the result stream are guaranteed not to have changed between their read_time and this one. If the query returns no results, a response with read_time and no document will be sent, and this represents the time at which the query was run.

.google.protobuf.Timestamp read_time = 3;

Returns
TypeDescription
TimestampOrBuilder

getSkippedResults()

public abstract int getSkippedResults()

The number of results that have been skipped due to an offset between the last response and the current response.

int32 skipped_results = 4;

Returns
TypeDescription
int

The skippedResults.

getTransaction()

public abstract ByteString getTransaction()

The transaction that was started as part of this request. Can only be set in the first response, and only if RunQueryRequest.new_transaction was set in the request. If set, no other fields will be set in this response.

bytes transaction = 2;

Returns
TypeDescription
ByteString

The transaction.

hasDocument()

public abstract boolean hasDocument()

A query result. Not set when reporting partial progress.

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

Returns
TypeDescription
boolean

Whether the document field is set.

hasReadTime()

public abstract boolean hasReadTime()

The time at which the document was read. This may be monotonically increasing; in this case, the previous documents in the result stream are guaranteed not to have changed between their read_time and this one. If the query returns no results, a response with read_time and no document will be sent, and this represents the time at which the query was run.

.google.protobuf.Timestamp read_time = 3;

Returns
TypeDescription
boolean

Whether the readTime field is set.