Class ExecutionStats.Builder (2.19.0)

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
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ExecutionStats.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ExecutionStats.Builder
Overrides

build()

public ExecutionStats build()
Returns
TypeDescription
ExecutionStats

buildPartial()

public ExecutionStats buildPartial()
Returns
TypeDescription
ExecutionStats

clear()

public ExecutionStats.Builder clear()
Returns
TypeDescription
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
TypeDescription
ExecutionStats.Builder

clearExecutionDuration()

public ExecutionStats.Builder clearExecutionDuration()

Total time to execute the query in the backend.

.google.protobuf.Duration execution_duration = 3;

Returns
TypeDescription
ExecutionStats.Builder

clearField(Descriptors.FieldDescriptor field)

public ExecutionStats.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ExecutionStats.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ExecutionStats.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ExecutionStats.Builder
Overrides

clearReadOperations()

public ExecutionStats.Builder clearReadOperations()

Total billable read operations.

int64 read_operations = 4;

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

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ExecutionStats getDefaultInstanceForType()
Returns
TypeDescription
ExecutionStats

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getExecutionDuration()

public Duration getExecutionDuration()

Total time to execute the query in the backend.

.google.protobuf.Duration execution_duration = 3;

Returns
TypeDescription
Duration

The executionDuration.

getExecutionDurationBuilder()

public Duration.Builder getExecutionDurationBuilder()

Total time to execute the query in the backend.

.google.protobuf.Duration execution_duration = 3;

Returns
TypeDescription
Builder

getExecutionDurationOrBuilder()

public DurationOrBuilder getExecutionDurationOrBuilder()

Total time to execute the query in the backend.

.google.protobuf.Duration execution_duration = 3;

Returns
TypeDescription
DurationOrBuilder

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
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
NameDescription
valueStruct
Returns
TypeDescription
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
NameDescription
valueDuration
Returns
TypeDescription
ExecutionStats.Builder

mergeFrom(ExecutionStats other)

public ExecutionStats.Builder mergeFrom(ExecutionStats other)
Parameter
NameDescription
otherExecutionStats
Returns
TypeDescription
ExecutionStats.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ExecutionStats.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExecutionStats.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ExecutionStats.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ExecutionStats.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ExecutionStats.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valueStruct
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
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
NameDescription
valueDuration
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
ExecutionStats.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ExecutionStats.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ExecutionStats.Builder
Overrides

setReadOperations(long value)

public ExecutionStats.Builder setReadOperations(long value)

Total billable read operations.

int64 read_operations = 4;

Parameter
NameDescription
valuelong

The readOperations to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
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
NameDescription
valuelong

The resultsReturned to set.

Returns
TypeDescription
ExecutionStats.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ExecutionStats.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ExecutionStats.Builder
Overrides