Class ResultSetMetadata (6.68.0)

public final class ResultSetMetadata extends GeneratedMessageV3 implements ResultSetMetadataOrBuilder

Metadata about a ResultSet or PartialResultSet.

Protobuf type google.spanner.v1.ResultSetMetadata

Static Fields

ROW_TYPE_FIELD_NUMBER

public static final int ROW_TYPE_FIELD_NUMBER
Field Value
Type Description
int

TRANSACTION_FIELD_NUMBER

public static final int TRANSACTION_FIELD_NUMBER
Field Value
Type Description
int

UNDECLARED_PARAMETERS_FIELD_NUMBER

public static final int UNDECLARED_PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ResultSetMetadata getDefaultInstance()
Returns
Type Description
ResultSetMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ResultSetMetadata.Builder newBuilder()
Returns
Type Description
ResultSetMetadata.Builder

newBuilder(ResultSetMetadata prototype)

public static ResultSetMetadata.Builder newBuilder(ResultSetMetadata prototype)
Parameter
Name Description
prototype ResultSetMetadata
Returns
Type Description
ResultSetMetadata.Builder

parseDelimitedFrom(InputStream input)

public static ResultSetMetadata parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ResultSetMetadata
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ResultSetMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResultSetMetadata
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ResultSetMetadata parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ResultSetMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ResultSetMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResultSetMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ResultSetMetadata parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ResultSetMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ResultSetMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResultSetMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ResultSetMetadata parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ResultSetMetadata
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ResultSetMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResultSetMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ResultSetMetadata parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ResultSetMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ResultSetMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResultSetMetadata
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ResultSetMetadata parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ResultSetMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ResultSetMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResultSetMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ResultSetMetadata> parser()
Returns
Type Description
Parser<ResultSetMetadata>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ResultSetMetadata getDefaultInstanceForType()
Returns
Type Description
ResultSetMetadata

getParserForType()

public Parser<ResultSetMetadata> getParserForType()
Returns
Type Description
Parser<ResultSetMetadata>
Overrides

getRowType()

public StructType getRowType()

Indicates the field names and types for the rows in the result set. For example, a SQL query like "SELECT UserId, UserName FROM Users" could return a row_type value like:

 "fields": [
   { "name": "UserId", "type": { "code": "INT64" } },
   { "name": "UserName", "type": { "code": "STRING" } },
 ]

.google.spanner.v1.StructType row_type = 1;

Returns
Type Description
StructType

The rowType.

getRowTypeOrBuilder()

public StructTypeOrBuilder getRowTypeOrBuilder()

Indicates the field names and types for the rows in the result set. For example, a SQL query like "SELECT UserId, UserName FROM Users" could return a row_type value like:

 "fields": [
   { "name": "UserId", "type": { "code": "INT64" } },
   { "name": "UserName", "type": { "code": "STRING" } },
 ]

.google.spanner.v1.StructType row_type = 1;

Returns
Type Description
StructTypeOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTransaction()

public Transaction getTransaction()

If the read or SQL query began a transaction as a side-effect, the information about the new transaction is yielded here.

.google.spanner.v1.Transaction transaction = 2;

Returns
Type Description
Transaction

The transaction.

getTransactionOrBuilder()

public TransactionOrBuilder getTransactionOrBuilder()

If the read or SQL query began a transaction as a side-effect, the information about the new transaction is yielded here.

.google.spanner.v1.Transaction transaction = 2;

Returns
Type Description
TransactionOrBuilder

getUndeclaredParameters()

public StructType getUndeclaredParameters()

A SQL query can be parameterized. In PLAN mode, these parameters can be undeclared. This indicates the field names and types for those undeclared parameters in the SQL query. For example, a SQL query like "SELECT * FROM Users where UserId = @userId and UserName = @userName " could return a undeclared_parameters value like:

 "fields": [
   { "name": "UserId", "type": { "code": "INT64" } },
   { "name": "UserName", "type": { "code": "STRING" } },
 ]

.google.spanner.v1.StructType undeclared_parameters = 3;

Returns
Type Description
StructType

The undeclaredParameters.

getUndeclaredParametersOrBuilder()

public StructTypeOrBuilder getUndeclaredParametersOrBuilder()

A SQL query can be parameterized. In PLAN mode, these parameters can be undeclared. This indicates the field names and types for those undeclared parameters in the SQL query. For example, a SQL query like "SELECT * FROM Users where UserId = @userId and UserName = @userName " could return a undeclared_parameters value like:

 "fields": [
   { "name": "UserId", "type": { "code": "INT64" } },
   { "name": "UserName", "type": { "code": "STRING" } },
 ]

.google.spanner.v1.StructType undeclared_parameters = 3;

Returns
Type Description
StructTypeOrBuilder

hasRowType()

public boolean hasRowType()

Indicates the field names and types for the rows in the result set. For example, a SQL query like "SELECT UserId, UserName FROM Users" could return a row_type value like:

 "fields": [
   { "name": "UserId", "type": { "code": "INT64" } },
   { "name": "UserName", "type": { "code": "STRING" } },
 ]

.google.spanner.v1.StructType row_type = 1;

Returns
Type Description
boolean

Whether the rowType field is set.

hasTransaction()

public boolean hasTransaction()

If the read or SQL query began a transaction as a side-effect, the information about the new transaction is yielded here.

.google.spanner.v1.Transaction transaction = 2;

Returns
Type Description
boolean

Whether the transaction field is set.

hasUndeclaredParameters()

public boolean hasUndeclaredParameters()

A SQL query can be parameterized. In PLAN mode, these parameters can be undeclared. This indicates the field names and types for those undeclared parameters in the SQL query. For example, a SQL query like "SELECT * FROM Users where UserId = @userId and UserName = @userName " could return a undeclared_parameters value like:

 "fields": [
   { "name": "UserId", "type": { "code": "INT64" } },
   { "name": "UserName", "type": { "code": "STRING" } },
 ]

.google.spanner.v1.StructType undeclared_parameters = 3;

Returns
Type Description
boolean

Whether the undeclaredParameters field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ResultSetMetadata.Builder newBuilderForType()
Returns
Type Description
ResultSetMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ResultSetMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ResultSetMetadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ResultSetMetadata.Builder toBuilder()
Returns
Type Description
ResultSetMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException