Class ResultSetMetadata.Builder (6.89.0)

publicstaticfinalclassResultSetMetadata.BuilderextendsGeneratedMessageV3.Builder<ResultSetMetadata.Builder>implementsResultSetMetadataOrBuilder

Metadata about a ResultSet or PartialResultSet.

Protobuf type google.spanner.v1.ResultSetMetadata

Static Methods

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

publicResultSetMetadata.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ResultSetMetadata.Builder
Overrides

build()

publicResultSetMetadatabuild()
Returns
TypeDescription
ResultSetMetadata

buildPartial()

publicResultSetMetadatabuildPartial()
Returns
TypeDescription
ResultSetMetadata

clear()

publicResultSetMetadata.Builderclear()
Returns
TypeDescription
ResultSetMetadata.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

publicResultSetMetadata.BuilderclearField(Descriptors.FieldDescriptorfield)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ResultSetMetadata.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

publicResultSetMetadata.BuilderclearOneof(Descriptors.OneofDescriptoroneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ResultSetMetadata.Builder
Overrides

clearRowType()

publicResultSetMetadata.BuilderclearRowType()

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

clearTransaction()

publicResultSetMetadata.BuilderclearTransaction()

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

clearUndeclaredParameters()

publicResultSetMetadata.BuilderclearUndeclaredParameters()

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

clone()

publicResultSetMetadata.Builderclone()
Returns
TypeDescription
ResultSetMetadata.Builder
Overrides

getDefaultInstanceForType()

publicResultSetMetadatagetDefaultInstanceForType()
Returns
TypeDescription
ResultSetMetadata

getDescriptorForType()

publicDescriptors.DescriptorgetDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getRowType()

publicStructTypegetRowType()

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
TypeDescription
StructType

The rowType.

getRowTypeBuilder()

publicStructType.BuildergetRowTypeBuilder()

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

getRowTypeOrBuilder()

publicStructTypeOrBuildergetRowTypeOrBuilder()

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
TypeDescription
StructTypeOrBuilder

getTransaction()

publicTransactiongetTransaction()

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
TypeDescription
Transaction

The transaction.

getTransactionBuilder()

publicTransaction.BuildergetTransactionBuilder()

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

getTransactionOrBuilder()

publicTransactionOrBuildergetTransactionOrBuilder()

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
TypeDescription
TransactionOrBuilder

getUndeclaredParameters()

publicStructTypegetUndeclaredParameters()

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
TypeDescription
StructType

The undeclaredParameters.

getUndeclaredParametersBuilder()

publicStructType.BuildergetUndeclaredParametersBuilder()

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

getUndeclaredParametersOrBuilder()

publicStructTypeOrBuildergetUndeclaredParametersOrBuilder()

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
TypeDescription
StructTypeOrBuilder

hasRowType()

publicbooleanhasRowType()

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
TypeDescription
boolean

Whether the rowType field is set.

hasTransaction()

publicbooleanhasTransaction()

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
TypeDescription
boolean

Whether the transaction field is set.

hasUndeclaredParameters()

publicbooleanhasUndeclaredParameters()

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
TypeDescription
boolean

Whether the undeclaredParameters field is set.

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicResultSetMetadata.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ResultSetMetadata.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

publicResultSetMetadata.BuildermergeFrom(Messageother)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ResultSetMetadata.Builder
Overrides

mergeFrom(ResultSetMetadata other)

publicResultSetMetadata.BuildermergeFrom(ResultSetMetadataother)
Parameter
NameDescription
otherResultSetMetadata
Returns
TypeDescription
ResultSetMetadata.Builder

mergeRowType(StructType value)

publicResultSetMetadata.BuildermergeRowType(StructTypevalue)

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
NameDescription
valueStructType
Returns
TypeDescription
ResultSetMetadata.Builder

mergeTransaction(Transaction value)

publicResultSetMetadata.BuildermergeTransaction(Transactionvalue)

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
NameDescription
valueTransaction
Returns
TypeDescription
ResultSetMetadata.Builder

mergeUndeclaredParameters(StructType value)

publicResultSetMetadata.BuildermergeUndeclaredParameters(StructTypevalue)

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
NameDescription
valueStructType
Returns
TypeDescription
ResultSetMetadata.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

publicfinalResultSetMetadata.BuildermergeUnknownFields(UnknownFieldSetunknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ResultSetMetadata.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

publicResultSetMetadata.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ResultSetMetadata.Builder
Overrides

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

publicResultSetMetadata.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ResultSetMetadata.Builder
Overrides

setRowType(StructType value)

publicResultSetMetadata.BuildersetRowType(StructTypevalue)

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
NameDescription
valueStructType
Returns
TypeDescription
ResultSetMetadata.Builder

setRowType(StructType.Builder builderForValue)

publicResultSetMetadata.BuildersetRowType(StructType.BuilderbuilderForValue)

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
NameDescription
builderForValueStructType.Builder
Returns
TypeDescription
ResultSetMetadata.Builder

setTransaction(Transaction value)

publicResultSetMetadata.BuildersetTransaction(Transactionvalue)

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
NameDescription
valueTransaction
Returns
TypeDescription
ResultSetMetadata.Builder

setTransaction(Transaction.Builder builderForValue)

publicResultSetMetadata.BuildersetTransaction(Transaction.BuilderbuilderForValue)

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
NameDescription
builderForValueTransaction.Builder
Returns
TypeDescription
ResultSetMetadata.Builder

setUndeclaredParameters(StructType value)

publicResultSetMetadata.BuildersetUndeclaredParameters(StructTypevalue)

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
NameDescription
valueStructType
Returns
TypeDescription
ResultSetMetadata.Builder

setUndeclaredParameters(StructType.Builder builderForValue)

publicResultSetMetadata.BuildersetUndeclaredParameters(StructType.BuilderbuilderForValue)

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
NameDescription
builderForValueStructType.Builder
Returns
TypeDescription
ResultSetMetadata.Builder

setUnknownFields(UnknownFieldSet unknownFields)

publicfinalResultSetMetadata.BuildersetUnknownFields(UnknownFieldSetunknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ResultSetMetadata.Builder
Overrides