Class ResultSetStats (6.25.1)

Stay organized with collections Save and categorize content based on your preferences.
public final class ResultSetStats extends GeneratedMessageV3 implements ResultSetStatsOrBuilder

Additional statistics about a ResultSet or PartialResultSet.

Protobuf type google.spanner.v1.ResultSetStats

Static Fields

QUERY_PLAN_FIELD_NUMBER

public static final int QUERY_PLAN_FIELD_NUMBER
Field Value
TypeDescription
int

QUERY_STATS_FIELD_NUMBER

public static final int QUERY_STATS_FIELD_NUMBER
Field Value
TypeDescription
int

ROW_COUNT_EXACT_FIELD_NUMBER

public static final int ROW_COUNT_EXACT_FIELD_NUMBER
Field Value
TypeDescription
int

ROW_COUNT_LOWER_BOUND_FIELD_NUMBER

public static final int ROW_COUNT_LOWER_BOUND_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ResultSetStats getDefaultInstance()
Returns
TypeDescription
ResultSetStats

getDescriptor()

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

newBuilder()

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

newBuilder(ResultSetStats prototype)

public static ResultSetStats.Builder newBuilder(ResultSetStats prototype)
Parameter
NameDescription
prototypeResultSetStats
Returns
TypeDescription
ResultSetStats.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ResultSetStats getDefaultInstanceForType()
Returns
TypeDescription
ResultSetStats

getParserForType()

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

getQueryPlan()

public QueryPlan getQueryPlan()

QueryPlan for the query associated with this result.

.google.spanner.v1.QueryPlan query_plan = 1;

Returns
TypeDescription
QueryPlan

The queryPlan.

getQueryPlanOrBuilder()

public QueryPlanOrBuilder getQueryPlanOrBuilder()

QueryPlan for the query associated with this result.

.google.spanner.v1.QueryPlan query_plan = 1;

Returns
TypeDescription
QueryPlanOrBuilder

getQueryStats()

public 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;

Returns
TypeDescription
Struct

The queryStats.

getQueryStatsOrBuilder()

public 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;

Returns
TypeDescription
StructOrBuilder

getRowCountCase()

public ResultSetStats.RowCountCase getRowCountCase()
Returns
TypeDescription
ResultSetStats.RowCountCase

getRowCountExact()

public long getRowCountExact()

Standard DML returns an exact count of rows that were modified.

int64 row_count_exact = 3;

Returns
TypeDescription
long

The rowCountExact.

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;

Returns
TypeDescription
long

The rowCountLowerBound.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasQueryPlan()

public boolean hasQueryPlan()

QueryPlan for the query associated with this result.

.google.spanner.v1.QueryPlan query_plan = 1;

Returns
TypeDescription
boolean

Whether the queryPlan field is set.

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;

Returns
TypeDescription
boolean

Whether the queryStats field is set.

hasRowCountExact()

public boolean hasRowCountExact()

Standard DML returns an exact count of rows that were modified.

int64 row_count_exact = 3;

Returns
TypeDescription
boolean

Whether the rowCountExact field is set.

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;

Returns
TypeDescription
boolean

Whether the rowCountLowerBound 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 ResultSetStats.Builder newBuilderForType()
Returns
TypeDescription
ResultSetStats.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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