Interface ResultSetStatsOrBuilder (3.16.1)

public interface ResultSetStatsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getQueryPlan()

public abstract QueryPlan getQueryPlan()

Plan for the query.

.google.firestore.v1.QueryPlan query_plan = 1;

Returns
TypeDescription
QueryPlan

The queryPlan.

getQueryPlanOrBuilder()

public abstract QueryPlanOrBuilder getQueryPlanOrBuilder()

Plan for the query.

.google.firestore.v1.QueryPlan query_plan = 1;

Returns
TypeDescription
QueryPlanOrBuilder

getQueryStats()

public abstract Struct getQueryStats()

Aggregated statistics from the execution of the query.

This will only be present when the request specifies PROFILE mode. For example, a query will return the statistics including:

{ "results_returned": "20", "documents_scanned": "20", "indexes_entries_scanned": "10050", "total_execution_time": "100.7 msecs" }

.google.protobuf.Struct query_stats = 2;

Returns
TypeDescription
Struct

The queryStats.

getQueryStatsOrBuilder()

public abstract StructOrBuilder getQueryStatsOrBuilder()

Aggregated statistics from the execution of the query.

This will only be present when the request specifies PROFILE mode. For example, a query will return the statistics including:

{ "results_returned": "20", "documents_scanned": "20", "indexes_entries_scanned": "10050", "total_execution_time": "100.7 msecs" }

.google.protobuf.Struct query_stats = 2;

Returns
TypeDescription
StructOrBuilder

hasQueryPlan()

public abstract boolean hasQueryPlan()

Plan for the query.

.google.firestore.v1.QueryPlan query_plan = 1;

Returns
TypeDescription
boolean

Whether the queryPlan field is set.

hasQueryStats()

public abstract boolean hasQueryStats()

Aggregated statistics from the execution of the query.

This will only be present when the request specifies PROFILE mode. For example, a query will return the statistics including:

{ "results_returned": "20", "documents_scanned": "20", "indexes_entries_scanned": "10050", "total_execution_time": "100.7 msecs" }

.google.protobuf.Struct query_stats = 2;

Returns
TypeDescription
boolean

Whether the queryStats field is set.