Class ExplainMetrics.Builder (3.21.0)

public static final class ExplainMetrics.Builder extends GeneratedMessageV3.Builder<ExplainMetrics.Builder> implements ExplainMetricsOrBuilder

Explain metrics for the query.

Protobuf type google.firestore.v1.ExplainMetrics

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ExplainMetrics build()
Returns
Type Description
ExplainMetrics

buildPartial()

public ExplainMetrics buildPartial()
Returns
Type Description
ExplainMetrics

clear()

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

clearExecutionStats()

public ExplainMetrics.Builder clearExecutionStats()

Aggregated stats from the execution of the query. Only present when ExplainOptions.analyze is set to true.

.google.firestore.v1.ExecutionStats execution_stats = 2;

Returns
Type Description
ExplainMetrics.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPlanSummary()

public ExplainMetrics.Builder clearPlanSummary()

Planning phase information for the query.

.google.firestore.v1.PlanSummary plan_summary = 1;

Returns
Type Description
ExplainMetrics.Builder

clone()

public ExplainMetrics.Builder clone()
Returns
Type Description
ExplainMetrics.Builder
Overrides

getDefaultInstanceForType()

public ExplainMetrics getDefaultInstanceForType()
Returns
Type Description
ExplainMetrics

getDescriptorForType()

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

getExecutionStats()

public ExecutionStats getExecutionStats()

Aggregated stats from the execution of the query. Only present when ExplainOptions.analyze is set to true.

.google.firestore.v1.ExecutionStats execution_stats = 2;

Returns
Type Description
ExecutionStats

The executionStats.

getExecutionStatsBuilder()

public ExecutionStats.Builder getExecutionStatsBuilder()

Aggregated stats from the execution of the query. Only present when ExplainOptions.analyze is set to true.

.google.firestore.v1.ExecutionStats execution_stats = 2;

Returns
Type Description
ExecutionStats.Builder

getExecutionStatsOrBuilder()

public ExecutionStatsOrBuilder getExecutionStatsOrBuilder()

Aggregated stats from the execution of the query. Only present when ExplainOptions.analyze is set to true.

.google.firestore.v1.ExecutionStats execution_stats = 2;

Returns
Type Description
ExecutionStatsOrBuilder

getPlanSummary()

public PlanSummary getPlanSummary()

Planning phase information for the query.

.google.firestore.v1.PlanSummary plan_summary = 1;

Returns
Type Description
PlanSummary

The planSummary.

getPlanSummaryBuilder()

public PlanSummary.Builder getPlanSummaryBuilder()

Planning phase information for the query.

.google.firestore.v1.PlanSummary plan_summary = 1;

Returns
Type Description
PlanSummary.Builder

getPlanSummaryOrBuilder()

public PlanSummaryOrBuilder getPlanSummaryOrBuilder()

Planning phase information for the query.

.google.firestore.v1.PlanSummary plan_summary = 1;

Returns
Type Description
PlanSummaryOrBuilder

hasExecutionStats()

public boolean hasExecutionStats()

Aggregated stats from the execution of the query. Only present when ExplainOptions.analyze is set to true.

.google.firestore.v1.ExecutionStats execution_stats = 2;

Returns
Type Description
boolean

Whether the executionStats field is set.

hasPlanSummary()

public boolean hasPlanSummary()

Planning phase information for the query.

.google.firestore.v1.PlanSummary plan_summary = 1;

Returns
Type Description
boolean

Whether the planSummary field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeExecutionStats(ExecutionStats value)

public ExplainMetrics.Builder mergeExecutionStats(ExecutionStats value)

Aggregated stats from the execution of the query. Only present when ExplainOptions.analyze is set to true.

.google.firestore.v1.ExecutionStats execution_stats = 2;

Parameter
Name Description
value ExecutionStats
Returns
Type Description
ExplainMetrics.Builder

mergeFrom(ExplainMetrics other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergePlanSummary(PlanSummary value)

public ExplainMetrics.Builder mergePlanSummary(PlanSummary value)

Planning phase information for the query.

.google.firestore.v1.PlanSummary plan_summary = 1;

Parameter
Name Description
value PlanSummary
Returns
Type Description
ExplainMetrics.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setExecutionStats(ExecutionStats value)

public ExplainMetrics.Builder setExecutionStats(ExecutionStats value)

Aggregated stats from the execution of the query. Only present when ExplainOptions.analyze is set to true.

.google.firestore.v1.ExecutionStats execution_stats = 2;

Parameter
Name Description
value ExecutionStats
Returns
Type Description
ExplainMetrics.Builder

setExecutionStats(ExecutionStats.Builder builderForValue)

public ExplainMetrics.Builder setExecutionStats(ExecutionStats.Builder builderForValue)

Aggregated stats from the execution of the query. Only present when ExplainOptions.analyze is set to true.

.google.firestore.v1.ExecutionStats execution_stats = 2;

Parameter
Name Description
builderForValue ExecutionStats.Builder
Returns
Type Description
ExplainMetrics.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setPlanSummary(PlanSummary value)

public ExplainMetrics.Builder setPlanSummary(PlanSummary value)

Planning phase information for the query.

.google.firestore.v1.PlanSummary plan_summary = 1;

Parameter
Name Description
value PlanSummary
Returns
Type Description
ExplainMetrics.Builder

setPlanSummary(PlanSummary.Builder builderForValue)

public ExplainMetrics.Builder setPlanSummary(PlanSummary.Builder builderForValue)

Planning phase information for the query.

.google.firestore.v1.PlanSummary plan_summary = 1;

Parameter
Name Description
builderForValue PlanSummary.Builder
Returns
Type Description
ExplainMetrics.Builder

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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