public static final class ExecutionStats.Builder extends GeneratedMessageV3.Builder<ExecutionStats.Builder> implements ExecutionStatsOrBuilder
Execution statistics for the query.
Protobuf type google.firestore.v1.ExecutionStats
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ExecutionStats.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public ExecutionStats build()
buildPartial()
public ExecutionStats buildPartial()
clear()
public ExecutionStats.Builder clear()
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;
clearExecutionDuration()
public ExecutionStats.Builder clearExecutionDuration()
Total time to execute the query in the backend.
.google.protobuf.Duration execution_duration = 3;
clearField(Descriptors.FieldDescriptor field)
public ExecutionStats.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public ExecutionStats.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clearReadOperations()
public ExecutionStats.Builder clearReadOperations()
Total billable read operations.
int64 read_operations = 4;
clearResultsReturned()
public ExecutionStats.Builder clearResultsReturned()
Total number of results returned, including documents, projections,
aggregation results, keys.
int64 results_returned = 1;
clone()
public ExecutionStats.Builder clone()
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;
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;
getDefaultInstanceForType()
public ExecutionStats getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
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;
getExecutionDurationOrBuilder()
public DurationOrBuilder getExecutionDurationOrBuilder()
Total time to execute the query in the backend.
.google.protobuf.Duration execution_duration = 3;
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()
Overrides
isInitialized()
public final boolean isInitialized()
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
|
mergeExecutionDuration(Duration value)
public ExecutionStats.Builder mergeExecutionDuration(Duration value)
Total time to execute the query in the backend.
.google.protobuf.Duration execution_duration = 3;
mergeFrom(ExecutionStats other)
public ExecutionStats.Builder mergeFrom(ExecutionStats other)
public ExecutionStats.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public ExecutionStats.Builder mergeFrom(Message other)
| Parameter |
|---|
| Name | Description |
other | Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ExecutionStats.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
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
|
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
|
setExecutionDuration(Duration value)
public ExecutionStats.Builder setExecutionDuration(Duration value)
Total time to execute the query in the backend.
.google.protobuf.Duration execution_duration = 3;
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
|
setField(Descriptors.FieldDescriptor field, Object value)
public ExecutionStats.Builder setField(Descriptors.FieldDescriptor field, Object value)
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.
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ExecutionStats.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
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.
|
setUnknownFields(UnknownFieldSet unknownFields)
public final ExecutionStats.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
