Package com.google.firestore.v1

Class ExplainMetrics

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.firestore.v1.ExplainMetrics
All Implemented Interfaces:
ExplainMetricsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class ExplainMetrics extends com.google.protobuf.GeneratedMessageV3 implements ExplainMetricsOrBuilder
 Explain metrics for the query.
Protobuf type google.firestore.v1.ExplainMetrics
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    ExplainMetrics.Builder
    Explain metrics for the query.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    EXECUTION_STATS_FIELD_NUMBER
     
    static final int
    PLAN_SUMMARY_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static ExplainMetrics
    getDefaultInstance()
     
    ExplainMetrics
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    ExecutionStats
    getExecutionStats()
    Aggregated stats from the execution of the query.
    ExecutionStatsOrBuilder
    getExecutionStatsOrBuilder()
    Aggregated stats from the execution of the query.
    com.google.protobuf.Parser<ExplainMetrics>
    getParserForType()
     
    PlanSummary
    getPlanSummary()
    Planning phase information for the query.
    PlanSummaryOrBuilder
    getPlanSummaryOrBuilder()
    Planning phase information for the query.
    int
    getSerializedSize()
     
    boolean
    hasExecutionStats()
    Aggregated stats from the execution of the query.
    int
    hashCode()
     
    boolean
    hasPlanSummary()
    Planning phase information for the query.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static ExplainMetrics.Builder
    newBuilder()
     
    static ExplainMetrics.Builder
    newBuilder(ExplainMetrics prototype)
     
    ExplainMetrics.Builder
    newBuilderForType()
     
    protected ExplainMetrics.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static ExplainMetrics
    parseDelimitedFrom(InputStream input)
     
    static ExplainMetrics
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ExplainMetrics
    parseFrom(byte[] data)
     
    static ExplainMetrics
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ExplainMetrics
    parseFrom(com.google.protobuf.ByteString data)
     
    static ExplainMetrics
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ExplainMetrics
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static ExplainMetrics
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ExplainMetrics
    parseFrom(InputStream input)
     
    static ExplainMetrics
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ExplainMetrics
    parseFrom(ByteBuffer data)
     
    static ExplainMetrics
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<ExplainMetrics>
    parser()
     
    ExplainMetrics.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • PLAN_SUMMARY_FIELD_NUMBER

      public static final int PLAN_SUMMARY_FIELD_NUMBER
      See Also:

    • EXECUTION_STATS_FIELD_NUMBER

      public static final int EXECUTION_STATS_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • hasPlanSummary

      public boolean hasPlanSummary()
       Planning phase information for the query.
      .google.firestore.v1.PlanSummary plan_summary = 1;
      Specified by:
      hasPlanSummary in interface ExplainMetricsOrBuilder
      Returns:
      Whether the planSummary field is set.

    • getPlanSummary

      public PlanSummary getPlanSummary()
       Planning phase information for the query.
      .google.firestore.v1.PlanSummary plan_summary = 1;
      Specified by:
      getPlanSummary in interface ExplainMetricsOrBuilder
      Returns:
      The planSummary.

    • getPlanSummaryOrBuilder

      public PlanSummaryOrBuilder getPlanSummaryOrBuilder()
       Planning phase information for the query.
      .google.firestore.v1.PlanSummary plan_summary = 1;
      Specified by:
      getPlanSummaryOrBuilder in interface ExplainMetricsOrBuilder

    • hasExecutionStats

      public boolean hasExecutionStats()
       Aggregated stats from the execution of the query. Only present when
 [ExplainOptions.analyze][google.firestore.v1.ExplainOptions.analyze] is set
 to true.
      .google.firestore.v1.ExecutionStats execution_stats = 2;
      Specified by:
      hasExecutionStats in interface ExplainMetricsOrBuilder
      Returns:
      Whether the executionStats field is set.

    • getExecutionStats

      public ExecutionStats getExecutionStats()
       Aggregated stats from the execution of the query. Only present when
 [ExplainOptions.analyze][google.firestore.v1.ExplainOptions.analyze] is set
 to true.
      .google.firestore.v1.ExecutionStats execution_stats = 2;
      Specified by:
      getExecutionStats in interface ExplainMetricsOrBuilder
      Returns:
      The executionStats.

    • getExecutionStatsOrBuilder

      public ExecutionStatsOrBuilder getExecutionStatsOrBuilder()
       Aggregated stats from the execution of the query. Only present when
 [ExplainOptions.analyze][google.firestore.v1.ExplainOptions.analyze] is set
 to true.
      .google.firestore.v1.ExecutionStats execution_stats = 2;
      Specified by:
      getExecutionStatsOrBuilder in interface ExplainMetricsOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ExplainMetrics parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExplainMetrics parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExplainMetrics parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExplainMetrics parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExplainMetrics parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExplainMetrics parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExplainMetrics parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ExplainMetrics parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ExplainMetrics parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ExplainMetrics parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ExplainMetrics parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ExplainMetrics parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ExplainMetrics.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ExplainMetrics.Builder newBuilder()

    • newBuilder

      public static ExplainMetrics.Builder newBuilder(ExplainMetrics prototype)

    • toBuilder

      public ExplainMetrics.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ExplainMetrics.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static ExplainMetrics getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ExplainMetrics> parser()

    • getParserForType

      public com.google.protobuf.Parser<ExplainMetrics> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public ExplainMetrics getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder