Class ResultSetMetadata.Builder (6.68.0)

public static final class ResultSetMetadata.Builder extends GeneratedMessageV3.Builder<ResultSetMetadata.Builder> implements ResultSetMetadataOrBuilder

Metadata about a ResultSet or PartialResultSet.

Protobuf type google.spanner.v1.ResultSetMetadata

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ResultSetMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ResultSetMetadata.Builder
Overrides

build()

public ResultSetMetadata build()
Returns
Type Description
ResultSetMetadata

buildPartial()

public ResultSetMetadata buildPartial()
Returns
Type Description
ResultSetMetadata

clear()

public ResultSetMetadata.Builder clear()
Returns
Type Description
ResultSetMetadata.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ResultSetMetadata.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ResultSetMetadata.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ResultSetMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ResultSetMetadata.Builder
Overrides

clearRowType()

public ResultSetMetadata.Builder clearRowType()

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
ResultSetMetadata.Builder

clearTransaction()

public ResultSetMetadata.Builder clearTransaction()

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
ResultSetMetadata.Builder

clearUndeclaredParameters()

public ResultSetMetadata.Builder clearUndeclaredParameters()

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
ResultSetMetadata.Builder

clone()

public ResultSetMetadata.Builder clone()
Returns
Type Description
ResultSetMetadata.Builder
Overrides

getDefaultInstanceForType()

public ResultSetMetadata getDefaultInstanceForType()
Returns
Type Description
ResultSetMetadata

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
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.

getRowTypeBuilder()

public StructType.Builder getRowTypeBuilder()

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.Builder

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

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.

getTransactionBuilder()

public Transaction.Builder getTransactionBuilder()

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.Builder

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.

getUndeclaredParametersBuilder()

public StructType.Builder getUndeclaredParametersBuilder()

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.Builder

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ResultSetMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResultSetMetadata.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ResultSetMetadata.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ResultSetMetadata.Builder
Overrides

mergeFrom(ResultSetMetadata other)

public ResultSetMetadata.Builder mergeFrom(ResultSetMetadata other)
Parameter
Name Description
other ResultSetMetadata
Returns
Type Description
ResultSetMetadata.Builder

mergeRowType(StructType value)

public ResultSetMetadata.Builder mergeRowType(StructType value)

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;

Parameter
Name Description
value StructType
Returns
Type Description
ResultSetMetadata.Builder

mergeTransaction(Transaction value)

public ResultSetMetadata.Builder mergeTransaction(Transaction value)

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;

Parameter
Name Description
value Transaction
Returns
Type Description
ResultSetMetadata.Builder

mergeUndeclaredParameters(StructType value)

public ResultSetMetadata.Builder mergeUndeclaredParameters(StructType value)

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;

Parameter
Name Description
value StructType
Returns
Type Description
ResultSetMetadata.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ResultSetMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ResultSetMetadata.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ResultSetMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ResultSetMetadata.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ResultSetMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ResultSetMetadata.Builder
Overrides

setRowType(StructType value)

public ResultSetMetadata.Builder setRowType(StructType value)

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;

Parameter
Name Description
value StructType
Returns
Type Description
ResultSetMetadata.Builder

setRowType(StructType.Builder builderForValue)

public ResultSetMetadata.Builder setRowType(StructType.Builder builderForValue)

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;

Parameter
Name Description
builderForValue StructType.Builder
Returns
Type Description
ResultSetMetadata.Builder

setTransaction(Transaction value)

public ResultSetMetadata.Builder setTransaction(Transaction value)

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;

Parameter
Name Description
value Transaction
Returns
Type Description
ResultSetMetadata.Builder

setTransaction(Transaction.Builder builderForValue)

public ResultSetMetadata.Builder setTransaction(Transaction.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Transaction.Builder
Returns
Type Description
ResultSetMetadata.Builder

setUndeclaredParameters(StructType value)

public ResultSetMetadata.Builder setUndeclaredParameters(StructType value)

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;

Parameter
Name Description
value StructType
Returns
Type Description
ResultSetMetadata.Builder

setUndeclaredParameters(StructType.Builder builderForValue)

public ResultSetMetadata.Builder setUndeclaredParameters(StructType.Builder builderForValue)

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;

Parameter
Name Description
builderForValue StructType.Builder
Returns
Type Description
ResultSetMetadata.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final ResultSetMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ResultSetMetadata.Builder
Overrides