Package com.google.firestore.v1

Class ResultSetStats

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.firestore.v1.ResultSetStats
All Implemented Interfaces:
ResultSetStatsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class ResultSetStats extends com.google.protobuf.GeneratedMessageV3 implements ResultSetStatsOrBuilder
 Planning and execution statistics for the query.
Protobuf type google.firestore.v1.ResultSetStats
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    ResultSetStats.Builder
    Planning and execution statistics 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
    QUERY_PLAN_FIELD_NUMBER
     
    static final int
    QUERY_STATS_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 ResultSetStats
    getDefaultInstance()
     
    ResultSetStats
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<ResultSetStats>
    getParserForType()
     
    QueryPlan
    getQueryPlan()
    Plan for the query.
    QueryPlanOrBuilder
    getQueryPlanOrBuilder()
    Plan for the query.
    com.google.protobuf.Struct
    getQueryStats()
    Aggregated statistics from the execution of the query.
    com.google.protobuf.StructOrBuilder
    getQueryStatsOrBuilder()
    Aggregated statistics from the execution of the query.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    boolean
    hasQueryPlan()
    Plan for the query.
    boolean
    hasQueryStats()
    Aggregated statistics from the execution of the query.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static ResultSetStats.Builder
    newBuilder()
     
    static ResultSetStats.Builder
    newBuilder(ResultSetStats prototype)
     
    ResultSetStats.Builder
    newBuilderForType()
     
    protected ResultSetStats.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static ResultSetStats
    parseDelimitedFrom(InputStream input)
     
    static ResultSetStats
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ResultSetStats
    parseFrom(byte[] data)
     
    static ResultSetStats
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ResultSetStats
    parseFrom(com.google.protobuf.ByteString data)
     
    static ResultSetStats
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ResultSetStats
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static ResultSetStats
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ResultSetStats
    parseFrom(InputStream input)
     
    static ResultSetStats
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ResultSetStats
    parseFrom(ByteBuffer data)
     
    static ResultSetStats
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<ResultSetStats>
    parser()
     
    ResultSetStats.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

    • QUERY_PLAN_FIELD_NUMBER

      public static final int QUERY_PLAN_FIELD_NUMBER
      See Also:

    • QUERY_STATS_FIELD_NUMBER

      public static final int QUERY_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

    • hasQueryPlan

      public boolean hasQueryPlan()
       Plan for the query.
      .google.firestore.v1.QueryPlan query_plan = 1;
      Specified by:
      hasQueryPlan in interface ResultSetStatsOrBuilder
      Returns:
      Whether the queryPlan field is set.

    • getQueryPlan

      public QueryPlan getQueryPlan()
       Plan for the query.
      .google.firestore.v1.QueryPlan query_plan = 1;
      Specified by:
      getQueryPlan in interface ResultSetStatsOrBuilder
      Returns:
      The queryPlan.

    • getQueryPlanOrBuilder

      public QueryPlanOrBuilder getQueryPlanOrBuilder()
       Plan for the query.
      .google.firestore.v1.QueryPlan query_plan = 1;
      Specified by:
      getQueryPlanOrBuilder in interface ResultSetStatsOrBuilder

    • hasQueryStats

      public boolean hasQueryStats()
       Aggregated statistics from the execution of the query.

 This will only be present when the request specifies `PROFILE` mode.
 For example, a query will return the statistics including:

 {
   "results_returned": "20",
   "documents_scanned": "20",
   "indexes_entries_scanned": "10050",
   "total_execution_time": "100.7 msecs"
 }
      .google.protobuf.Struct query_stats = 2;
      Specified by:
      hasQueryStats in interface ResultSetStatsOrBuilder
      Returns:
      Whether the queryStats field is set.

    • getQueryStats

      public com.google.protobuf.Struct getQueryStats()
       Aggregated statistics from the execution of the query.

 This will only be present when the request specifies `PROFILE` mode.
 For example, a query will return the statistics including:

 {
   "results_returned": "20",
   "documents_scanned": "20",
   "indexes_entries_scanned": "10050",
   "total_execution_time": "100.7 msecs"
 }
      .google.protobuf.Struct query_stats = 2;
      Specified by:
      getQueryStats in interface ResultSetStatsOrBuilder
      Returns:
      The queryStats.

    • getQueryStatsOrBuilder

      public com.google.protobuf.StructOrBuilder getQueryStatsOrBuilder()
       Aggregated statistics from the execution of the query.

 This will only be present when the request specifies `PROFILE` mode.
 For example, a query will return the statistics including:

 {
   "results_returned": "20",
   "documents_scanned": "20",
   "indexes_entries_scanned": "10050",
   "total_execution_time": "100.7 msecs"
 }
      .google.protobuf.Struct query_stats = 2;
      Specified by:
      getQueryStatsOrBuilder in interface ResultSetStatsOrBuilder

    • 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 ResultSetStats parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ResultSetStats.Builder newBuilder()

    • newBuilder

      public static ResultSetStats.Builder newBuilder(ResultSetStats prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ResultSetStats getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<ResultSetStats> 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 ResultSetStats getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder