Interface ResultSetStatsOrBuilder (3.16.1)

Version latest

• 3.25.1 (latest)
• 3.24.3
• 3.22.0
• 3.21.4
• 3.20.0
• 3.17.0
• 3.16.3
• 3.15.7
• 3.14.4
• 3.13.2
• 3.12.1
• 3.11.0
• 3.10.0
• 3.9.6
• 3.8.2
• 3.7.10
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.21

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
Type	Description
QueryPlan	The queryPlan.

getQueryPlanOrBuilder()

public abstract QueryPlanOrBuilder getQueryPlanOrBuilder()

Plan for the query.

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

Returns
Type	Description
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
Type	Description
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
Type	Description
StructOrBuilder

hasQueryPlan()

public abstract boolean hasQueryPlan()

Plan for the query.

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

Returns
Type	Description
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
Type	Description
boolean	Whether the queryStats field is set.