Class ExplainMetrics.Builder (3.21.0)

Version 3.21.0

• 3.27.2 (latest)
• 3.26.5
• 3.25.1
• 3.24.3
• 3.22.0
• 3.21.4
• 3.20.0
• 3.17.0
• 3.16.3
• 3.15.7
• 3.14.4
• 3.13.2
• 3.12.1
• 3.11.0
• 3.10.0
• 3.9.6
• 3.8.2
• 3.7.10
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.21

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

Explain metrics for the query.

Protobuf type google.firestore.v1.ExplainMetrics

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ExplainMetrics.Builder

Implements

ExplainMetricsOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

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

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public ExplainMetrics.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
ExplainMetrics.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public ExplainMetrics getDefaultInstanceForType()

Returns
Type	Description
ExplainMetrics

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public ExplainMetrics.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
ExplainMetrics.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final ExplainMetrics.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
ExplainMetrics.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)