Interface RunQueryResponseOrBuilder (3.21.4) 

public interface RunQueryResponseOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getContinuationSelectorCase()

public abstract RunQueryResponse.ContinuationSelectorCase getContinuationSelectorCase()
Returns
Type Description
RunQueryResponse.ContinuationSelectorCase

getDocument()

public abstract Document getDocument()

A query result, not set when reporting partial progress.

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

Returns
Type Description
Document

The document.

getDocumentOrBuilder()

public abstract DocumentOrBuilder getDocumentOrBuilder()

A query result, not set when reporting partial progress.

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

Returns
Type Description
DocumentOrBuilder

getDone()

public abstract boolean getDone()

If present, Firestore has completely finished the request and no more documents will be returned.

bool done = 6;

Returns
Type Description
boolean

The done.

getExplainMetrics()

public abstract ExplainMetrics getExplainMetrics()

Query explain metrics. This is only present when the RunQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream.

.google.firestore.v1.ExplainMetrics explain_metrics = 11;

Returns
Type Description
ExplainMetrics

The explainMetrics.

getExplainMetricsOrBuilder()

public abstract ExplainMetricsOrBuilder getExplainMetricsOrBuilder()

Query explain metrics. This is only present when the RunQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream.

.google.firestore.v1.ExplainMetrics explain_metrics = 11;

Returns
Type Description
ExplainMetricsOrBuilder

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
Type Description
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
Type Description
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
Type Description
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
Type Description
ByteString

The transaction.

hasDocument()

public abstract boolean hasDocument()

A query result, not set when reporting partial progress.

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

Returns
Type Description
boolean

Whether the document field is set.

hasDone()

public abstract boolean hasDone()

If present, Firestore has completely finished the request and no more documents will be returned.

bool done = 6;

Returns
Type Description
boolean

Whether the done field is set.

hasExplainMetrics()

public abstract boolean hasExplainMetrics()

Query explain metrics. This is only present when the RunQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream.

.google.firestore.v1.ExplainMetrics explain_metrics = 11;

Returns
Type Description
boolean

Whether the explainMetrics 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
Type Description
boolean

Whether the readTime field is set.