Class ResultSetStats.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ResultSetStatsOrBuilder, Cloneable
    Enclosing class:
    ResultSetStats

    public static final class ResultSetStats.Builder
    extends com.google.protobuf.GeneratedMessageV3.Builder<ResultSetStats.Builder>
    implements ResultSetStatsOrBuilder
     Additional statistics about a [ResultSet][google.spanner.v1.ResultSet] or [PartialResultSet][google.spanner.v1.PartialResultSet].
     
    Protobuf type google.spanner.v1.ResultSetStats
    • Method Detail

      • 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.Builder<ResultSetStats.Builder>
      • clear

        public ResultSetStats.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<ResultSetStats.Builder>
      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ResultSetStats.Builder>
      • getDefaultInstanceForType

        public ResultSetStats getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
      • build

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

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

        public ResultSetStats.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<ResultSetStats.Builder>
      • setField

        public ResultSetStats.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<ResultSetStats.Builder>
      • clearField

        public ResultSetStats.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ResultSetStats.Builder>
      • clearOneof

        public ResultSetStats.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ResultSetStats.Builder>
      • setRepeatedField

        public ResultSetStats.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                       int index,
                                                       Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ResultSetStats.Builder>
      • addRepeatedField

        public ResultSetStats.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                       Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ResultSetStats.Builder>
      • mergeFrom

        public ResultSetStats.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ResultSetStats.Builder>
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ResultSetStats.Builder>
      • mergeFrom

        public ResultSetStats.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ResultSetStats.Builder>
        Throws:
        IOException
      • 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.
      • setQueryPlan

        public ResultSetStats.Builder setQueryPlan​(QueryPlan value)
         [QueryPlan][google.spanner.v1.QueryPlan] for the query associated with this result.
         
        .google.spanner.v1.QueryPlan query_plan = 1;
      • setQueryPlan

        public ResultSetStats.Builder setQueryPlan​(QueryPlan.Builder builderForValue)
         [QueryPlan][google.spanner.v1.QueryPlan] for the query associated with this result.
         
        .google.spanner.v1.QueryPlan query_plan = 1;
      • mergeQueryPlan

        public ResultSetStats.Builder mergeQueryPlan​(QueryPlan value)
         [QueryPlan][google.spanner.v1.QueryPlan] for the query associated with this result.
         
        .google.spanner.v1.QueryPlan query_plan = 1;
      • clearQueryPlan

        public ResultSetStats.Builder clearQueryPlan()
         [QueryPlan][google.spanner.v1.QueryPlan] for the query associated with this result.
         
        .google.spanner.v1.QueryPlan query_plan = 1;
      • getQueryPlanBuilder

        public QueryPlan.Builder getQueryPlanBuilder()
         [QueryPlan][google.spanner.v1.QueryPlan] for the query associated with this result.
         
        .google.spanner.v1.QueryPlan query_plan = 1;
      • 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.
      • setQueryStats

        public ResultSetStats.Builder setQueryStats​(com.google.protobuf.Struct value)
         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;
      • setQueryStats

        public ResultSetStats.Builder setQueryStats​(com.google.protobuf.Struct.Builder builderForValue)
         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;
      • mergeQueryStats

        public ResultSetStats.Builder mergeQueryStats​(com.google.protobuf.Struct value)
         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;
      • clearQueryStats

        public ResultSetStats.Builder clearQueryStats()
         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;
      • getQueryStatsBuilder

        public com.google.protobuf.Struct.Builder getQueryStatsBuilder()
         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;
      • 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.
      • setRowCountExact

        public ResultSetStats.Builder setRowCountExact​(long value)
         Standard DML returns an exact count of rows that were modified.
         
        int64 row_count_exact = 3;
        Parameters:
        value - The rowCountExact to set.
        Returns:
        This builder for chaining.
      • clearRowCountExact

        public ResultSetStats.Builder clearRowCountExact()
         Standard DML returns an exact count of rows that were modified.
         
        int64 row_count_exact = 3;
        Returns:
        This builder for chaining.
      • 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.
      • setRowCountLowerBound

        public ResultSetStats.Builder setRowCountLowerBound​(long value)
         Partitioned DML does not offer exactly-once semantics, so it
         returns a lower bound of the rows modified.
         
        int64 row_count_lower_bound = 4;
        Parameters:
        value - The rowCountLowerBound to set.
        Returns:
        This builder for chaining.
      • clearRowCountLowerBound

        public ResultSetStats.Builder clearRowCountLowerBound()
         Partitioned DML does not offer exactly-once semantics, so it
         returns a lower bound of the rows modified.
         
        int64 row_count_lower_bound = 4;
        Returns:
        This builder for chaining.
      • setUnknownFields

        public final ResultSetStats.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ResultSetStats.Builder>
      • mergeUnknownFields

        public final ResultSetStats.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ResultSetStats.Builder>