Class ExplainMetrics (2.19.0)

public final class ExplainMetrics extends GeneratedMessageV3 implements ExplainMetricsOrBuilder

Explain metrics for the query.

Protobuf type google.datastore.v1.ExplainMetrics

Static Fields

EXECUTION_STATS_FIELD_NUMBER

public static final int EXECUTION_STATS_FIELD_NUMBER
Field Value
TypeDescription
int

PLAN_SUMMARY_FIELD_NUMBER

public static final int PLAN_SUMMARY_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ExplainMetrics getDefaultInstance()
Returns
TypeDescription
ExplainMetrics

getDescriptor()

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

newBuilder()

public static ExplainMetrics.Builder newBuilder()
Returns
TypeDescription
ExplainMetrics.Builder

newBuilder(ExplainMetrics prototype)

public static ExplainMetrics.Builder newBuilder(ExplainMetrics prototype)
Parameter
NameDescription
prototypeExplainMetrics
Returns
TypeDescription
ExplainMetrics.Builder

parseDelimitedFrom(InputStream input)

public static ExplainMetrics parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ExplainMetrics
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplainMetrics parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExplainMetrics
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ExplainMetrics parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ExplainMetrics
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExplainMetrics parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExplainMetrics
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExplainMetrics parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ExplainMetrics
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExplainMetrics parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExplainMetrics
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExplainMetrics parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ExplainMetrics
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplainMetrics parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExplainMetrics
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ExplainMetrics parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ExplainMetrics
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplainMetrics parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExplainMetrics
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ExplainMetrics parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ExplainMetrics
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExplainMetrics parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExplainMetrics
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ExplainMetrics> parser()
Returns
TypeDescription
Parser<ExplainMetrics>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public ExplainMetrics getDefaultInstanceForType()
Returns
TypeDescription
ExplainMetrics

getExecutionStats()

public ExecutionStats getExecutionStats()

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

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

Returns
TypeDescription
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.datastore.v1.ExecutionStats execution_stats = 2;

Returns
TypeDescription
ExecutionStatsOrBuilder

getParserForType()

public Parser<ExplainMetrics> getParserForType()
Returns
TypeDescription
Parser<ExplainMetrics>
Overrides

getPlanSummary()

public PlanSummary getPlanSummary()

Planning phase information for the query.

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

Returns
TypeDescription
PlanSummary

The planSummary.

getPlanSummaryOrBuilder()

public PlanSummaryOrBuilder getPlanSummaryOrBuilder()

Planning phase information for the query.

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

Returns
TypeDescription
PlanSummaryOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasExecutionStats()

public boolean hasExecutionStats()

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

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

Returns
TypeDescription
boolean

Whether the executionStats field is set.

hasPlanSummary()

public boolean hasPlanSummary()

Planning phase information for the query.

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

Returns
TypeDescription
boolean

Whether the planSummary field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ExplainMetrics.Builder newBuilderForType()
Returns
TypeDescription
ExplainMetrics.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExplainMetrics.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ExplainMetrics.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ExplainMetrics.Builder toBuilder()
Returns
TypeDescription
ExplainMetrics.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException