Class ExplainMetrics (3.21.4)

public final class ExplainMetrics extends GeneratedMessageV3 implements ExplainMetricsOrBuilder

Explain metrics for the query.

Protobuf type google.firestore.v1.ExplainMetrics

Static Fields

EXECUTION_STATS_FIELD_NUMBER

public static final int EXECUTION_STATS_FIELD_NUMBER
Field Value
Type Description
int

PLAN_SUMMARY_FIELD_NUMBER

public static final int PLAN_SUMMARY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ExplainMetrics getDefaultInstance()
Returns
Type Description
ExplainMetrics

getDescriptor()

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

newBuilder()

public static ExplainMetrics.Builder newBuilder()
Returns
Type Description
ExplainMetrics.Builder

newBuilder(ExplainMetrics prototype)

public static ExplainMetrics.Builder newBuilder(ExplainMetrics prototype)
Parameter
Name Description
prototype ExplainMetrics
Returns
Type Description
ExplainMetrics.Builder

parseDelimitedFrom(InputStream input)

public static ExplainMetrics parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExplainMetrics
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplainMetrics parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplainMetrics
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ExplainMetrics parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ExplainMetrics
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExplainMetrics parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplainMetrics
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExplainMetrics parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ExplainMetrics
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExplainMetrics parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplainMetrics
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExplainMetrics parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ExplainMetrics
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplainMetrics parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplainMetrics
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ExplainMetrics parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExplainMetrics
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplainMetrics parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplainMetrics
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ExplainMetrics parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ExplainMetrics
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExplainMetrics parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplainMetrics
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ExplainMetrics> parser()
Returns
Type Description
Parser<ExplainMetrics>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ExplainMetrics getDefaultInstanceForType()
Returns
Type Description
ExplainMetrics

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.

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

getParserForType()

public Parser<ExplainMetrics> getParserForType()
Returns
Type Description
Parser<ExplainMetrics>
Overrides

getPlanSummary()

public PlanSummary getPlanSummary()

Planning phase information for the query.

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

Returns
Type Description
PlanSummary

The planSummary.

getPlanSummaryOrBuilder()

public PlanSummaryOrBuilder getPlanSummaryOrBuilder()

Planning phase information for the query.

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

Returns
Type Description
PlanSummaryOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ExplainMetrics.Builder newBuilderForType()
Returns
Type Description
ExplainMetrics.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExplainMetrics.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ExplainMetrics.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ExplainMetrics.Builder toBuilder()
Returns
Type Description
ExplainMetrics.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException