Interface ExecutionStatsOrBuilder (2.22.0)

Version 2.22.0

• 2.24.1 (latest)
• 2.23.0
• 2.22.0
• 2.21.3
• 2.20.2
• 2.19.2
• 2.18.5
• 2.17.6

public interface ExecutionStatsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDebugStats()

public abstract Struct getDebugStats()

Debugging statistics from the execution of the query. Note that the debugging stats are subject to change as Firestore evolves. It could include: { "indexes_entries_scanned": "1000", "documents_scanned": "20", "billing_details" : { "documents_billable": "20", "index_entries_billable": "1000", "min_query_cost": "0" } }

.google.protobuf.Struct debug_stats = 5;

Returns
Type	Description
Struct	The debugStats.

getDebugStatsOrBuilder()

public abstract StructOrBuilder getDebugStatsOrBuilder()

Debugging statistics from the execution of the query. Note that the debugging stats are subject to change as Firestore evolves. It could include: { "indexes_entries_scanned": "1000", "documents_scanned": "20", "billing_details" : { "documents_billable": "20", "index_entries_billable": "1000", "min_query_cost": "0" } }

.google.protobuf.Struct debug_stats = 5;

Returns
Type	Description
StructOrBuilder

getExecutionDuration()

public abstract Duration getExecutionDuration()

Total time to execute the query in the backend.

.google.protobuf.Duration execution_duration = 3;

Returns
Type	Description
Duration	The executionDuration.

getExecutionDurationOrBuilder()

public abstract DurationOrBuilder getExecutionDurationOrBuilder()

Total time to execute the query in the backend.

.google.protobuf.Duration execution_duration = 3;

Returns
Type	Description
DurationOrBuilder

getReadOperations()

public abstract long getReadOperations()

Total billable read operations.

int64 read_operations = 4;

Returns
Type	Description
long	The readOperations.

getResultsReturned()

public abstract long getResultsReturned()

Total number of results returned, including documents, projections, aggregation results, keys.

int64 results_returned = 1;

Returns
Type	Description
long	The resultsReturned.

hasDebugStats()

public abstract boolean hasDebugStats()

Debugging statistics from the execution of the query. Note that the debugging stats are subject to change as Firestore evolves. It could include: { "indexes_entries_scanned": "1000", "documents_scanned": "20", "billing_details" : { "documents_billable": "20", "index_entries_billable": "1000", "min_query_cost": "0" } }

.google.protobuf.Struct debug_stats = 5;

Returns
Type	Description
boolean	Whether the debugStats field is set.

hasExecutionDuration()

public abstract boolean hasExecutionDuration()

Total time to execute the query in the backend.

.google.protobuf.Duration execution_duration = 3;

Returns
Type	Description
boolean	Whether the executionDuration field is set.