Class ResultSetStats.Builder (3.16.1)

public static final class ResultSetStats.Builder extends GeneratedMessageV3.Builder<ResultSetStats.Builder> implements ResultSetStatsOrBuilder

Planning and execution statistics for the query.

Protobuf type google.firestore.v1.ResultSetStats

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ResultSetStats build()
Returns
TypeDescription
ResultSetStats

buildPartial()

public ResultSetStats buildPartial()
Returns
TypeDescription
ResultSetStats

clear()

public ResultSetStats.Builder clear()
Returns
TypeDescription
ResultSetStats.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearQueryPlan()

public ResultSetStats.Builder clearQueryPlan()

Plan for the query.

.google.firestore.v1.QueryPlan query_plan = 1;

Returns
TypeDescription
ResultSetStats.Builder

clearQueryStats()

public ResultSetStats.Builder clearQueryStats()

Aggregated statistics from the execution of the query.

This will only be present when the request specifies PROFILE mode. For example, a query will return the statistics including:

{ "results_returned": "20", "documents_scanned": "20", "indexes_entries_scanned": "10050", "total_execution_time": "100.7 msecs" }

.google.protobuf.Struct query_stats = 2;

Returns
TypeDescription
ResultSetStats.Builder

clone()

public ResultSetStats.Builder clone()
Returns
TypeDescription
ResultSetStats.Builder
Overrides

getDefaultInstanceForType()

public ResultSetStats getDefaultInstanceForType()
Returns
TypeDescription
ResultSetStats

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getQueryPlan()

public QueryPlan getQueryPlan()

Plan for the query.

.google.firestore.v1.QueryPlan query_plan = 1;

Returns
TypeDescription
QueryPlan

The queryPlan.

getQueryPlanBuilder()

public QueryPlan.Builder getQueryPlanBuilder()

Plan for the query.

.google.firestore.v1.QueryPlan query_plan = 1;

Returns
TypeDescription
QueryPlan.Builder

getQueryPlanOrBuilder()

public QueryPlanOrBuilder getQueryPlanOrBuilder()

Plan for the query.

.google.firestore.v1.QueryPlan query_plan = 1;

Returns
TypeDescription
QueryPlanOrBuilder

getQueryStats()

public Struct getQueryStats()

Aggregated statistics from the execution of the query.

This will only be present when the request specifies PROFILE mode. For example, a query will return the statistics including:

{ "results_returned": "20", "documents_scanned": "20", "indexes_entries_scanned": "10050", "total_execution_time": "100.7 msecs" }

.google.protobuf.Struct query_stats = 2;

Returns
TypeDescription
Struct

The queryStats.

getQueryStatsBuilder()

public Struct.Builder getQueryStatsBuilder()

Aggregated statistics from the execution of the query.

This will only be present when the request specifies PROFILE mode. For example, a query will return the statistics including:

{ "results_returned": "20", "documents_scanned": "20", "indexes_entries_scanned": "10050", "total_execution_time": "100.7 msecs" }

.google.protobuf.Struct query_stats = 2;

Returns
TypeDescription
Builder

getQueryStatsOrBuilder()

public StructOrBuilder getQueryStatsOrBuilder()

Aggregated statistics from the execution of the query.

This will only be present when the request specifies PROFILE mode. For example, a query will return the statistics including:

{ "results_returned": "20", "documents_scanned": "20", "indexes_entries_scanned": "10050", "total_execution_time": "100.7 msecs" }

.google.protobuf.Struct query_stats = 2;

Returns
TypeDescription
StructOrBuilder

hasQueryPlan()

public boolean hasQueryPlan()

Plan for the query.

.google.firestore.v1.QueryPlan query_plan = 1;

Returns
TypeDescription
boolean

Whether the queryPlan field is set.

hasQueryStats()

public boolean hasQueryStats()

Aggregated statistics from the execution of the query.

This will only be present when the request specifies PROFILE mode. For example, a query will return the statistics including:

{ "results_returned": "20", "documents_scanned": "20", "indexes_entries_scanned": "10050", "total_execution_time": "100.7 msecs" }

.google.protobuf.Struct query_stats = 2;

Returns
TypeDescription
boolean

Whether the queryStats field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ResultSetStats other)

public ResultSetStats.Builder mergeFrom(ResultSetStats other)
Parameter
NameDescription
otherResultSetStats
Returns
TypeDescription
ResultSetStats.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeQueryPlan(QueryPlan value)

public ResultSetStats.Builder mergeQueryPlan(QueryPlan value)

Plan for the query.

.google.firestore.v1.QueryPlan query_plan = 1;

Parameter
NameDescription
valueQueryPlan
Returns
TypeDescription
ResultSetStats.Builder

mergeQueryStats(Struct value)

public ResultSetStats.Builder mergeQueryStats(Struct value)

Aggregated statistics from the execution of the query.

This will only be present when the request specifies PROFILE mode. For example, a query will return the statistics including:

{ "results_returned": "20", "documents_scanned": "20", "indexes_entries_scanned": "10050", "total_execution_time": "100.7 msecs" }

.google.protobuf.Struct query_stats = 2;

Parameter
NameDescription
valueStruct
Returns
TypeDescription
ResultSetStats.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ResultSetStats.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ResultSetStats.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

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

setQueryPlan(QueryPlan value)

public ResultSetStats.Builder setQueryPlan(QueryPlan value)

Plan for the query.

.google.firestore.v1.QueryPlan query_plan = 1;

Parameter
NameDescription
valueQueryPlan
Returns
TypeDescription
ResultSetStats.Builder

setQueryPlan(QueryPlan.Builder builderForValue)

public ResultSetStats.Builder setQueryPlan(QueryPlan.Builder builderForValue)

Plan for the query.

.google.firestore.v1.QueryPlan query_plan = 1;

Parameter
NameDescription
builderForValueQueryPlan.Builder
Returns
TypeDescription
ResultSetStats.Builder

setQueryStats(Struct value)

public ResultSetStats.Builder setQueryStats(Struct value)

Aggregated statistics from the execution of the query.

This will only be present when the request specifies PROFILE mode. For example, a query will return the statistics including:

{ "results_returned": "20", "documents_scanned": "20", "indexes_entries_scanned": "10050", "total_execution_time": "100.7 msecs" }

.google.protobuf.Struct query_stats = 2;

Parameter
NameDescription
valueStruct
Returns
TypeDescription
ResultSetStats.Builder

setQueryStats(Struct.Builder builderForValue)

public ResultSetStats.Builder setQueryStats(Struct.Builder builderForValue)

Aggregated statistics from the execution of the query.

This will only be present when the request specifies PROFILE mode. For example, a query will return the statistics including:

{ "results_returned": "20", "documents_scanned": "20", "indexes_entries_scanned": "10050", "total_execution_time": "100.7 msecs" }

.google.protobuf.Struct query_stats = 2;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
ResultSetStats.Builder

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

public ResultSetStats.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ResultSetStats.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

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