public interface RunAggregationQueryResponseOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getExplainMetrics()
public abstract ExplainMetrics getExplainMetrics()
Query explain metrics. This is only present when the RunAggregationQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream.
.google.firestore.v1.ExplainMetrics explain_metrics = 10;
Returns | |
---|---|
Type | Description |
ExplainMetrics |
The explainMetrics. |
getExplainMetricsOrBuilder()
public abstract ExplainMetricsOrBuilder getExplainMetricsOrBuilder()
Query explain metrics. This is only present when the RunAggregationQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream.
.google.firestore.v1.ExplainMetrics explain_metrics = 10;
Returns | |
---|---|
Type | Description |
ExplainMetricsOrBuilder |
getReadTime()
public abstract Timestamp getReadTime()
The time at which the aggregate result was computed. This is always
monotonically increasing; in this case, the previous AggregationResult 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
result
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 aggregate result was computed. This is always
monotonically increasing; in this case, the previous AggregationResult 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
result
will be sent, and this represents the time at which the query
was run.
.google.protobuf.Timestamp read_time = 3;
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
getResult()
public abstract AggregationResult getResult()
A single aggregation result.
Not present when reporting partial progress.
.google.firestore.v1.AggregationResult result = 1;
Returns | |
---|---|
Type | Description |
AggregationResult |
The result. |
getResultOrBuilder()
public abstract AggregationResultOrBuilder getResultOrBuilder()
A single aggregation result.
Not present when reporting partial progress.
.google.firestore.v1.AggregationResult result = 1;
Returns | |
---|---|
Type | Description |
AggregationResultOrBuilder |
getTransaction()
public abstract ByteString getTransaction()
The transaction that was started as part of this request.
Only present on the first response when the request requested to start a new transaction.
bytes transaction = 2;
Returns | |
---|---|
Type | Description |
ByteString |
The transaction. |
hasExplainMetrics()
public abstract boolean hasExplainMetrics()
Query explain metrics. This is only present when the RunAggregationQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream.
.google.firestore.v1.ExplainMetrics explain_metrics = 10;
Returns | |
---|---|
Type | Description |
boolean |
Whether the explainMetrics field is set. |
hasReadTime()
public abstract boolean hasReadTime()
The time at which the aggregate result was computed. This is always
monotonically increasing; in this case, the previous AggregationResult 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
result
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. |
hasResult()
public abstract boolean hasResult()
A single aggregation result.
Not present when reporting partial progress.
.google.firestore.v1.AggregationResult result = 1;
Returns | |
---|---|
Type | Description |
boolean |
Whether the result field is set. |