Class ExecutionStats.Builder (2.21.3)

public static final class ExecutionStats.Builder extends GeneratedMessageV3.Builder<ExecutionStats.Builder> implements ExecutionStatsOrBuilder

Execution statistics for the query.

Protobuf type google.datastore.v1.ExecutionStats

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ExecutionStats.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ExecutionStats.Builder
Overrides

build()

public ExecutionStats build()
Returns
Type Description
ExecutionStats

buildPartial()

public ExecutionStats buildPartial()
Returns
Type Description
ExecutionStats

clear()

public ExecutionStats.Builder clear()
Returns
Type Description
ExecutionStats.Builder
Overrides

clearDebugStats()

public ExecutionStats.Builder clearDebugStats()

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
ExecutionStats.Builder

clearExecutionDuration()

public ExecutionStats.Builder clearExecutionDuration()

Total time to execute the query in the backend.

.google.protobuf.Duration execution_duration = 3;

Returns
Type Description
ExecutionStats.Builder

clearField(Descriptors.FieldDescriptor field)

public ExecutionStats.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ExecutionStats.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ExecutionStats.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ExecutionStats.Builder
Overrides

clearReadOperations()

public ExecutionStats.Builder clearReadOperations()

Total billable read operations.

int64 read_operations = 4;

Returns
Type Description
ExecutionStats.Builder

This builder for chaining.

clearResultsReturned()

public ExecutionStats.Builder clearResultsReturned()

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

int64 results_returned = 1;

Returns
Type Description
ExecutionStats.Builder

This builder for chaining.

clone()

public ExecutionStats.Builder clone()
Returns
Type Description
ExecutionStats.Builder
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.

getDebugStatsBuilder()

public Struct.Builder getDebugStatsBuilder()

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
Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getExecutionDurationBuilder()

public Duration.Builder getExecutionDurationBuilder()

Total time to execute the query in the backend.

.google.protobuf.Duration execution_duration = 3;

Returns
Type Description
Builder

getExecutionDurationOrBuilder()

public DurationOrBuilder getExecutionDurationOrBuilder()

Total time to execute the query in the backend.

.google.protobuf.Duration execution_duration = 3;

Returns
Type Description
DurationOrBuilder

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDebugStats(Struct value)

public ExecutionStats.Builder mergeDebugStats(Struct value)

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;

Parameter
Name Description
value Struct
Returns
Type Description
ExecutionStats.Builder

mergeExecutionDuration(Duration value)

public ExecutionStats.Builder mergeExecutionDuration(Duration value)

Total time to execute the query in the backend.

.google.protobuf.Duration execution_duration = 3;

Parameter
Name Description
value Duration
Returns
Type Description
ExecutionStats.Builder

mergeFrom(ExecutionStats other)

public ExecutionStats.Builder mergeFrom(ExecutionStats other)
Parameter
Name Description
other ExecutionStats
Returns
Type Description
ExecutionStats.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ExecutionStats.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecutionStats.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ExecutionStats.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ExecutionStats.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ExecutionStats.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ExecutionStats.Builder
Overrides

setDebugStats(Struct value)

public ExecutionStats.Builder setDebugStats(Struct value)

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;

Parameter
Name Description
value Struct
Returns
Type Description
ExecutionStats.Builder

setDebugStats(Struct.Builder builderForValue)

public ExecutionStats.Builder setDebugStats(Struct.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ExecutionStats.Builder

setExecutionDuration(Duration value)

public ExecutionStats.Builder setExecutionDuration(Duration value)

Total time to execute the query in the backend.

.google.protobuf.Duration execution_duration = 3;

Parameter
Name Description
value Duration
Returns
Type Description
ExecutionStats.Builder

setExecutionDuration(Duration.Builder builderForValue)

public ExecutionStats.Builder setExecutionDuration(Duration.Builder builderForValue)

Total time to execute the query in the backend.

.google.protobuf.Duration execution_duration = 3;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ExecutionStats.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ExecutionStats.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ExecutionStats.Builder
Overrides

setReadOperations(long value)

public ExecutionStats.Builder setReadOperations(long value)

Total billable read operations.

int64 read_operations = 4;

Parameter
Name Description
value long

The readOperations to set.

Returns
Type Description
ExecutionStats.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ExecutionStats.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ExecutionStats.Builder
Overrides

setResultsReturned(long value)

public ExecutionStats.Builder setResultsReturned(long value)

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

int64 results_returned = 1;

Parameter
Name Description
value long

The resultsReturned to set.

Returns
Type Description
ExecutionStats.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ExecutionStats.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ExecutionStats.Builder
Overrides