Class ExecutionStats (3.20.0)

public final class ExecutionStats extends GeneratedMessageV3 implements ExecutionStatsOrBuilder

Execution statistics for the query.

Protobuf type google.firestore.v1.ExecutionStats

Static Fields

DEBUG_STATS_FIELD_NUMBER

public static final int DEBUG_STATS_FIELD_NUMBER
Field Value
TypeDescription
int

EXECUTION_DURATION_FIELD_NUMBER

public static final int EXECUTION_DURATION_FIELD_NUMBER
Field Value
TypeDescription
int

READ_OPERATIONS_FIELD_NUMBER

public static final int READ_OPERATIONS_FIELD_NUMBER
Field Value
TypeDescription
int

RESULTS_RETURNED_FIELD_NUMBER

public static final int RESULTS_RETURNED_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ExecutionStats getDefaultInstance()
Returns
TypeDescription
ExecutionStats

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ExecutionStats.Builder newBuilder()
Returns
TypeDescription
ExecutionStats.Builder

newBuilder(ExecutionStats prototype)

public static ExecutionStats.Builder newBuilder(ExecutionStats prototype)
Parameter
NameDescription
prototypeExecutionStats
Returns
TypeDescription
ExecutionStats.Builder

parseDelimitedFrom(InputStream input)

public static ExecutionStats parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ExecutionStats
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecutionStats parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExecutionStats
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ExecutionStats parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ExecutionStats
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExecutionStats parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExecutionStats
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExecutionStats parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ExecutionStats
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExecutionStats parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExecutionStats
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExecutionStats parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ExecutionStats
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecutionStats parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExecutionStats
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ExecutionStats parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ExecutionStats
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecutionStats parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExecutionStats
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ExecutionStats parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ExecutionStats
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExecutionStats parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExecutionStats
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ExecutionStats> parser()
Returns
TypeDescription
Parser<ExecutionStats>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDebugStats()

public 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
TypeDescription
Struct

The debugStats.

getDebugStatsOrBuilder()

public 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
TypeDescription
StructOrBuilder

getDefaultInstanceForType()

public ExecutionStats getDefaultInstanceForType()
Returns
TypeDescription
ExecutionStats

getExecutionDuration()

public Duration getExecutionDuration()

Total time to execute the query in the backend.

.google.protobuf.Duration execution_duration = 3;

Returns
TypeDescription
Duration

The executionDuration.

getExecutionDurationOrBuilder()

public DurationOrBuilder getExecutionDurationOrBuilder()

Total time to execute the query in the backend.

.google.protobuf.Duration execution_duration = 3;

Returns
TypeDescription
DurationOrBuilder

getParserForType()

public Parser<ExecutionStats> getParserForType()
Returns
TypeDescription
Parser<ExecutionStats>
Overrides

getReadOperations()

public long getReadOperations()

Total billable read operations.

int64 read_operations = 4;

Returns
TypeDescription
long

The readOperations.

getResultsReturned()

public long getResultsReturned()

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

int64 results_returned = 1;

Returns
TypeDescription
long

The resultsReturned.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasDebugStats()

public 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
TypeDescription
boolean

Whether the debugStats field is set.

hasExecutionDuration()

public boolean hasExecutionDuration()

Total time to execute the query in the backend.

.google.protobuf.Duration execution_duration = 3;

Returns
TypeDescription
boolean

Whether the executionDuration field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ExecutionStats.Builder newBuilderForType()
Returns
TypeDescription
ExecutionStats.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExecutionStats.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ExecutionStats.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ExecutionStats.Builder toBuilder()
Returns
TypeDescription
ExecutionStats.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException