Interface RunAggregationQueryResponseOrBuilder (2.21.2)

public interface RunAggregationQueryResponseOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBatch()

public abstract AggregationResultBatch getBatch()

A batch of aggregation results. Always present.

.google.datastore.v1.AggregationResultBatch batch = 1;

Returns
Type Description
AggregationResultBatch

The batch.

getBatchOrBuilder()

public abstract AggregationResultBatchOrBuilder getBatchOrBuilder()

A batch of aggregation results. Always present.

.google.datastore.v1.AggregationResultBatch batch = 1;

Returns
Type Description
AggregationResultBatchOrBuilder

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.datastore.v1.ExplainMetrics explain_metrics = 9;

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.datastore.v1.ExplainMetrics explain_metrics = 9;

Returns
Type Description
ExplainMetricsOrBuilder

getQuery()

public abstract AggregationQuery getQuery()

The parsed form of the GqlQuery from the request, if it was set.

.google.datastore.v1.AggregationQuery query = 2;

Returns
Type Description
AggregationQuery

The query.

getQueryOrBuilder()

public abstract AggregationQueryOrBuilder getQueryOrBuilder()

The parsed form of the GqlQuery from the request, if it was set.

.google.datastore.v1.AggregationQuery query = 2;

Returns
Type Description
AggregationQueryOrBuilder

getTransaction()

public abstract ByteString getTransaction()

The identifier of the transaction that was started as part of this RunAggregationQuery request.

Set only when ReadOptions.new_transaction was set in RunAggregationQueryRequest.read_options.

bytes transaction = 5;

Returns
Type Description
ByteString

The transaction.

hasBatch()

public abstract boolean hasBatch()

A batch of aggregation results. Always present.

.google.datastore.v1.AggregationResultBatch batch = 1;

Returns
Type Description
boolean

Whether the batch field is set.

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.datastore.v1.ExplainMetrics explain_metrics = 9;

Returns
Type Description
boolean

Whether the explainMetrics field is set.

hasQuery()

public abstract boolean hasQuery()

The parsed form of the GqlQuery from the request, if it was set.

.google.datastore.v1.AggregationQuery query = 2;

Returns
Type Description
boolean

Whether the query field is set.