Class ExecutionStats (2.21.2)

public final class ExecutionStats extends GeneratedMessageV3 implements ExecutionStatsOrBuilder

Execution statistics for the query.

Protobuf type google.datastore.v1.ExecutionStats

Static Fields

DEBUG_STATS_FIELD_NUMBER

public static final int DEBUG_STATS_FIELD_NUMBER
Field Value
Type Description
int

EXECUTION_DURATION_FIELD_NUMBER

public static final int EXECUTION_DURATION_FIELD_NUMBER
Field Value
Type Description
int

READ_OPERATIONS_FIELD_NUMBER

public static final int READ_OPERATIONS_FIELD_NUMBER
Field Value
Type Description
int

RESULTS_RETURNED_FIELD_NUMBER

public static final int RESULTS_RETURNED_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ExecutionStats getDefaultInstance()
Returns
Type Description
ExecutionStats

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ExecutionStats.Builder newBuilder()
Returns
Type Description
ExecutionStats.Builder

newBuilder(ExecutionStats prototype)

public static ExecutionStats.Builder newBuilder(ExecutionStats prototype)
Parameter
Name Description
prototype ExecutionStats
Returns
Type Description
ExecutionStats.Builder

parseDelimitedFrom(InputStream input)

public static ExecutionStats parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExecutionStats
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecutionStats parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecutionStats
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ExecutionStats parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ExecutionStats
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExecutionStats parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecutionStats
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExecutionStats parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ExecutionStats
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExecutionStats parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecutionStats
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExecutionStats parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ExecutionStats
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecutionStats parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecutionStats
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ExecutionStats parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExecutionStats
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecutionStats parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecutionStats
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ExecutionStats parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ExecutionStats
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExecutionStats parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecutionStats
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ExecutionStats> parser()
Returns
Type Description
Parser<ExecutionStats>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
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
Type Description
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
Type Description
StructOrBuilder

getDefaultInstanceForType()

public ExecutionStats getDefaultInstanceForType()
Returns
Type Description
ExecutionStats

getExecutionDuration()

public 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 DurationOrBuilder getExecutionDurationOrBuilder()

Total time to execute the query in the backend.

.google.protobuf.Duration execution_duration = 3;

Returns
Type Description
DurationOrBuilder

getParserForType()

public Parser<ExecutionStats> getParserForType()
Returns
Type Description
Parser<ExecutionStats>
Overrides

getReadOperations()

public long getReadOperations()

Total billable read operations.

int64 read_operations = 4;

Returns
Type Description
long

The readOperations.

getResultsReturned()

public long getResultsReturned()

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

int64 results_returned = 1;

Returns
Type Description
long

The resultsReturned.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
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
Type Description
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
Type Description
boolean

Whether the executionDuration field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ExecutionStats.Builder newBuilderForType()
Returns
Type Description
ExecutionStats.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExecutionStats.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ExecutionStats.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ExecutionStats.Builder toBuilder()
Returns
Type Description
ExecutionStats.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException