Package com.google.spanner.v1

Class ResultSetStats

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ResultSetStatsOrBuilder, Serializable
    public final class ResultSetStats
extends com.google.protobuf.GeneratedMessageV3
implements ResultSetStatsOrBuilder
     Additional statistics about a [ResultSet][google.spanner.v1.ResultSet] or [PartialResultSet][google.spanner.v1.PartialResultSet].
    Protobuf type google.spanner.v1.ResultSetStats
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ResultSetStats.Builder
      Additional statistics about a [ResultSet][google.spanner.v1.ResultSet] or [PartialResultSet][google.spanner.v1.PartialResultSet].
      static class  ResultSetStats.RowCountCase  

      • 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 Detail

      • QUERY_PLAN_FIELD_NUMBER

        public static final int QUERY_PLAN_FIELD_NUMBER
        See Also:
        Constant Field Values

      • QUERY_STATS_FIELD_NUMBER

        public static final int QUERY_STATS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ROW_COUNT_EXACT_FIELD_NUMBER

        public static final int ROW_COUNT_EXACT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ROW_COUNT_LOWER_BOUND_FIELD_NUMBER

        public static final int ROW_COUNT_LOWER_BOUND_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • 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()
         [QueryPlan][google.spanner.v1.QueryPlan] for the query associated with this result.
        .google.spanner.v1.QueryPlan query_plan = 1;
        Specified by:
        hasQueryPlan in interface ResultSetStatsOrBuilder
        Returns:
        Whether the queryPlan field is set.

      • getQueryPlan

        public QueryPlan getQueryPlan()
         [QueryPlan][google.spanner.v1.QueryPlan] for the query associated with this result.
        .google.spanner.v1.QueryPlan query_plan = 1;
        Specified by:
        getQueryPlan in interface ResultSetStatsOrBuilder
        Returns:
        The queryPlan.

      • hasQueryStats

        public boolean hasQueryStats()
         Aggregated statistics from the execution of the query. Only present when
 the query is profiled. For example, a query could return the statistics as
 follows:

     {
       "rows_returned": "3",
       "elapsed_time": "1.22 secs",
       "cpu_time": "1.19 secs"
     }
        .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. Only present when
 the query is profiled. For example, a query could return the statistics as
 follows:

     {
       "rows_returned": "3",
       "elapsed_time": "1.22 secs",
       "cpu_time": "1.19 secs"
     }
        .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. Only present when
 the query is profiled. For example, a query could return the statistics as
 follows:

     {
       "rows_returned": "3",
       "elapsed_time": "1.22 secs",
       "cpu_time": "1.19 secs"
     }
        .google.protobuf.Struct query_stats = 2;
        Specified by:
        getQueryStatsOrBuilder in interface ResultSetStatsOrBuilder

      • hasRowCountExact

        public boolean hasRowCountExact()
         Standard DML returns an exact count of rows that were modified.
        int64 row_count_exact = 3;
        Specified by:
        hasRowCountExact in interface ResultSetStatsOrBuilder
        Returns:
        Whether the rowCountExact field is set.

      • getRowCountExact

        public long getRowCountExact()
         Standard DML returns an exact count of rows that were modified.
        int64 row_count_exact = 3;
        Specified by:
        getRowCountExact in interface ResultSetStatsOrBuilder
        Returns:
        The rowCountExact.

      • hasRowCountLowerBound

        public boolean hasRowCountLowerBound()
         Partitioned DML does not offer exactly-once semantics, so it
 returns a lower bound of the rows modified.
        int64 row_count_lower_bound = 4;
        Specified by:
        hasRowCountLowerBound in interface ResultSetStatsOrBuilder
        Returns:
        Whether the rowCountLowerBound field is set.

      • getRowCountLowerBound

        public long getRowCountLowerBound()
         Partitioned DML does not offer exactly-once semantics, so it
 returns a lower bound of the rows modified.
        int64 row_count_lower_bound = 4;
        Specified by:
        getRowCountLowerBound in interface ResultSetStatsOrBuilder
        Returns:
        The rowCountLowerBound.

      • 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​(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

      • 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