Class ResultSet.Builder (6.111.0) 

public static final class ResultSet.Builder extends GeneratedMessage.Builder<ResultSet.Builder> implements ResultSetOrBuilder

Results from Read or ExecuteSql.

Protobuf type google.spanner.v1.ResultSet

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > ResultSet.Builder

Implements

ResultSetOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllRows(Iterable<? extends ListValue> values)

public ResultSet.Builder addAllRows(Iterable<? extends ListValue> values)

Each element in rows is a row whose format is defined by metadata.row_type. The ith element in each row matches the ith field in metadata.row_type. Elements are encoded based on type as described here.

repeated .google.protobuf.ListValue rows = 2;

Parameter
Name Description
values Iterable<? extends com.google.protobuf.ListValue>
Returns
Type Description
ResultSet.Builder

addRows(ListValue value)

public ResultSet.Builder addRows(ListValue value)

Each element in rows is a row whose format is defined by metadata.row_type. The ith element in each row matches the ith field in metadata.row_type. Elements are encoded based on type as described here.

repeated .google.protobuf.ListValue rows = 2;

Parameter
Name Description
value ListValue
Returns
Type Description
ResultSet.Builder

addRows(ListValue.Builder builderForValue)

public ResultSet.Builder addRows(ListValue.Builder builderForValue)

Each element in rows is a row whose format is defined by metadata.row_type. The ith element in each row matches the ith field in metadata.row_type. Elements are encoded based on type as described here.

repeated .google.protobuf.ListValue rows = 2;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ResultSet.Builder

addRows(int index, ListValue value)

public ResultSet.Builder addRows(int index, ListValue value)

Each element in rows is a row whose format is defined by metadata.row_type. The ith element in each row matches the ith field in metadata.row_type. Elements are encoded based on type as described here.

repeated .google.protobuf.ListValue rows = 2;

Parameters
Name Description
index int
value ListValue
Returns
Type Description
ResultSet.Builder

addRows(int index, ListValue.Builder builderForValue)

public ResultSet.Builder addRows(int index, ListValue.Builder builderForValue)

Each element in rows is a row whose format is defined by metadata.row_type. The ith element in each row matches the ith field in metadata.row_type. Elements are encoded based on type as described here.

repeated .google.protobuf.ListValue rows = 2;

Parameters
Name Description
index int
builderForValue Builder
Returns
Type Description
ResultSet.Builder

addRowsBuilder()

public ListValue.Builder addRowsBuilder()

Each element in rows is a row whose format is defined by metadata.row_type. The ith element in each row matches the ith field in metadata.row_type. Elements are encoded based on type as described here.

repeated .google.protobuf.ListValue rows = 2;

Returns
Type Description
Builder

addRowsBuilder(int index)

public ListValue.Builder addRowsBuilder(int index)

Each element in rows is a row whose format is defined by metadata.row_type. The ith element in each row matches the ith field in metadata.row_type. Elements are encoded based on type as described here.

repeated .google.protobuf.ListValue rows = 2;

Parameter
Name Description
index int
Returns
Type Description
Builder

build()

public ResultSet build()
Returns
Type Description
ResultSet

buildPartial()

public ResultSet buildPartial()
Returns
Type Description
ResultSet

clear()

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

clearCacheUpdate()

public ResultSet.Builder clearCacheUpdate()

Optional. A cache update expresses a set of changes the client should incorporate into its location cache. The client should discard the changes if they are older than the data it already has. This data can be obtained in response to requests that included a RoutingHint field, but may also be obtained by explicit location-fetching RPCs which may be added in the future.

.google.spanner.v1.CacheUpdate cache_update = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ResultSet.Builder

clearMetadata()

public ResultSet.Builder clearMetadata()

Metadata about the result set, such as row type information.

.google.spanner.v1.ResultSetMetadata metadata = 1;

Returns
Type Description
ResultSet.Builder

clearPrecommitToken()

public ResultSet.Builder clearPrecommitToken()

Optional. A precommit token is included if the read-write transaction is on a multiplexed session. Pass the precommit token with the highest sequence number from this transaction attempt to the Commit request for this transaction.

.google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ResultSet.Builder

clearRows()

public ResultSet.Builder clearRows()

Each element in rows is a row whose format is defined by metadata.row_type. The ith element in each row matches the ith field in metadata.row_type. Elements are encoded based on type as described here.

repeated .google.protobuf.ListValue rows = 2;

Returns
Type Description
ResultSet.Builder

clearStats()

public ResultSet.Builder clearStats()

Query plan and execution statistics for the SQL statement that produced this result set. These can be requested by setting ExecuteSqlRequest.query_mode. DML statements always produce stats containing the number of rows modified, unless executed using the ExecuteSqlRequest.QueryMode.PLAN ExecuteSqlRequest.query_mode. Other fields might or might not be populated, based on the ExecuteSqlRequest.query_mode.

.google.spanner.v1.ResultSetStats stats = 3;

Returns
Type Description
ResultSet.Builder

getCacheUpdate()

public CacheUpdate getCacheUpdate()

Optional. A cache update expresses a set of changes the client should incorporate into its location cache. The client should discard the changes if they are older than the data it already has. This data can be obtained in response to requests that included a RoutingHint field, but may also be obtained by explicit location-fetching RPCs which may be added in the future.

.google.spanner.v1.CacheUpdate cache_update = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CacheUpdate

The cacheUpdate.

getCacheUpdateBuilder()

public CacheUpdate.Builder getCacheUpdateBuilder()

Optional. A cache update expresses a set of changes the client should incorporate into its location cache. The client should discard the changes if they are older than the data it already has. This data can be obtained in response to requests that included a RoutingHint field, but may also be obtained by explicit location-fetching RPCs which may be added in the future.

.google.spanner.v1.CacheUpdate cache_update = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CacheUpdate.Builder

getCacheUpdateOrBuilder()

public CacheUpdateOrBuilder getCacheUpdateOrBuilder()

Optional. A cache update expresses a set of changes the client should incorporate into its location cache. The client should discard the changes if they are older than the data it already has. This data can be obtained in response to requests that included a RoutingHint field, but may also be obtained by explicit location-fetching RPCs which may be added in the future.

.google.spanner.v1.CacheUpdate cache_update = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CacheUpdateOrBuilder

getDefaultInstanceForType()

public ResultSet getDefaultInstanceForType()
Returns
Type Description
ResultSet

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getMetadata()

public ResultSetMetadata getMetadata()

Metadata about the result set, such as row type information.

.google.spanner.v1.ResultSetMetadata metadata = 1;

Returns
Type Description
ResultSetMetadata

The metadata.

getMetadataBuilder()

public ResultSetMetadata.Builder getMetadataBuilder()

Metadata about the result set, such as row type information.

.google.spanner.v1.ResultSetMetadata metadata = 1;

Returns
Type Description
ResultSetMetadata.Builder

getMetadataOrBuilder()

public ResultSetMetadataOrBuilder getMetadataOrBuilder()

Metadata about the result set, such as row type information.

.google.spanner.v1.ResultSetMetadata metadata = 1;

Returns
Type Description
ResultSetMetadataOrBuilder

getPrecommitToken()

public MultiplexedSessionPrecommitToken getPrecommitToken()

Optional. A precommit token is included if the read-write transaction is on a multiplexed session. Pass the precommit token with the highest sequence number from this transaction attempt to the Commit request for this transaction.

.google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MultiplexedSessionPrecommitToken

The precommitToken.

getPrecommitTokenBuilder()

public MultiplexedSessionPrecommitToken.Builder getPrecommitTokenBuilder()

Optional. A precommit token is included if the read-write transaction is on a multiplexed session. Pass the precommit token with the highest sequence number from this transaction attempt to the Commit request for this transaction.

.google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MultiplexedSessionPrecommitToken.Builder

getPrecommitTokenOrBuilder()

public MultiplexedSessionPrecommitTokenOrBuilder getPrecommitTokenOrBuilder()

Optional. A precommit token is included if the read-write transaction is on a multiplexed session. Pass the precommit token with the highest sequence number from this transaction attempt to the Commit request for this transaction.

.google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MultiplexedSessionPrecommitTokenOrBuilder

getRows(int index)

public ListValue getRows(int index)

Each element in rows is a row whose format is defined by metadata.row_type. The ith element in each row matches the ith field in metadata.row_type. Elements are encoded based on type as described here.

repeated .google.protobuf.ListValue rows = 2;

Parameter
Name Description
index int
Returns
Type Description
ListValue

getRowsBuilder(int index)

public ListValue.Builder getRowsBuilder(int index)

Each element in rows is a row whose format is defined by metadata.row_type. The ith element in each row matches the ith field in metadata.row_type. Elements are encoded based on type as described here.

repeated .google.protobuf.ListValue rows = 2;

Parameter
Name Description
index int
Returns
Type Description
Builder

getRowsBuilderList()

public List<ListValue.Builder> getRowsBuilderList()

Each element in rows is a row whose format is defined by metadata.row_type. The ith element in each row matches the ith field in metadata.row_type. Elements are encoded based on type as described here.

repeated .google.protobuf.ListValue rows = 2;

Returns
Type Description
List<Builder>

getRowsCount()

public int getRowsCount()

Each element in rows is a row whose format is defined by metadata.row_type. The ith element in each row matches the ith field in metadata.row_type. Elements are encoded based on type as described here.

repeated .google.protobuf.ListValue rows = 2;

Returns
Type Description
int

getRowsList()

public List<ListValue> getRowsList()

Each element in rows is a row whose format is defined by metadata.row_type. The ith element in each row matches the ith field in metadata.row_type. Elements are encoded based on type as described here.

repeated .google.protobuf.ListValue rows = 2;

Returns
Type Description
List<ListValue>

getRowsOrBuilder(int index)

public ListValueOrBuilder getRowsOrBuilder(int index)

Each element in rows is a row whose format is defined by metadata.row_type. The ith element in each row matches the ith field in metadata.row_type. Elements are encoded based on type as described here.

repeated .google.protobuf.ListValue rows = 2;

Parameter
Name Description
index int
Returns
Type Description
ListValueOrBuilder

getRowsOrBuilderList()

public List<? extends ListValueOrBuilder> getRowsOrBuilderList()

Each element in rows is a row whose format is defined by metadata.row_type. The ith element in each row matches the ith field in metadata.row_type. Elements are encoded based on type as described here.

repeated .google.protobuf.ListValue rows = 2;

Returns
Type Description
List<? extends com.google.protobuf.ListValueOrBuilder>

getStats()

public ResultSetStats getStats()

Query plan and execution statistics for the SQL statement that produced this result set. These can be requested by setting ExecuteSqlRequest.query_mode. DML statements always produce stats containing the number of rows modified, unless executed using the ExecuteSqlRequest.QueryMode.PLAN ExecuteSqlRequest.query_mode. Other fields might or might not be populated, based on the ExecuteSqlRequest.query_mode.

.google.spanner.v1.ResultSetStats stats = 3;

Returns
Type Description
ResultSetStats

The stats.

getStatsBuilder()

public ResultSetStats.Builder getStatsBuilder()

Query plan and execution statistics for the SQL statement that produced this result set. These can be requested by setting ExecuteSqlRequest.query_mode. DML statements always produce stats containing the number of rows modified, unless executed using the ExecuteSqlRequest.QueryMode.PLAN ExecuteSqlRequest.query_mode. Other fields might or might not be populated, based on the ExecuteSqlRequest.query_mode.

.google.spanner.v1.ResultSetStats stats = 3;

Returns
Type Description
ResultSetStats.Builder

getStatsOrBuilder()

public ResultSetStatsOrBuilder getStatsOrBuilder()

Query plan and execution statistics for the SQL statement that produced this result set. These can be requested by setting ExecuteSqlRequest.query_mode. DML statements always produce stats containing the number of rows modified, unless executed using the ExecuteSqlRequest.QueryMode.PLAN ExecuteSqlRequest.query_mode. Other fields might or might not be populated, based on the ExecuteSqlRequest.query_mode.

.google.spanner.v1.ResultSetStats stats = 3;

Returns
Type Description
ResultSetStatsOrBuilder

hasCacheUpdate()

public boolean hasCacheUpdate()

Optional. A cache update expresses a set of changes the client should incorporate into its location cache. The client should discard the changes if they are older than the data it already has. This data can be obtained in response to requests that included a RoutingHint field, but may also be obtained by explicit location-fetching RPCs which may be added in the future.

.google.spanner.v1.CacheUpdate cache_update = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the cacheUpdate field is set.

hasMetadata()

public boolean hasMetadata()

Metadata about the result set, such as row type information.

.google.spanner.v1.ResultSetMetadata metadata = 1;

Returns
Type Description
boolean

Whether the metadata field is set.

hasPrecommitToken()

public boolean hasPrecommitToken()

Optional. A precommit token is included if the read-write transaction is on a multiplexed session. Pass the precommit token with the highest sequence number from this transaction attempt to the Commit request for this transaction.

.google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the precommitToken field is set.

hasStats()

public boolean hasStats()

Query plan and execution statistics for the SQL statement that produced this result set. These can be requested by setting ExecuteSqlRequest.query_mode. DML statements always produce stats containing the number of rows modified, unless executed using the ExecuteSqlRequest.QueryMode.PLAN ExecuteSqlRequest.query_mode. Other fields might or might not be populated, based on the ExecuteSqlRequest.query_mode.

.google.spanner.v1.ResultSetStats stats = 3;

Returns
Type Description
boolean

Whether the stats field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCacheUpdate(CacheUpdate value)

public ResultSet.Builder mergeCacheUpdate(CacheUpdate value)

Optional. A cache update expresses a set of changes the client should incorporate into its location cache. The client should discard the changes if they are older than the data it already has. This data can be obtained in response to requests that included a RoutingHint field, but may also be obtained by explicit location-fetching RPCs which may be added in the future.

.google.spanner.v1.CacheUpdate cache_update = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value CacheUpdate
Returns
Type Description
ResultSet.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeFrom(ResultSet other)

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

mergeMetadata(ResultSetMetadata value)

public ResultSet.Builder mergeMetadata(ResultSetMetadata value)

Metadata about the result set, such as row type information.

.google.spanner.v1.ResultSetMetadata metadata = 1;

Parameter
Name Description
value ResultSetMetadata
Returns
Type Description
ResultSet.Builder

mergePrecommitToken(MultiplexedSessionPrecommitToken value)

public ResultSet.Builder mergePrecommitToken(MultiplexedSessionPrecommitToken value)

Optional. A precommit token is included if the read-write transaction is on a multiplexed session. Pass the precommit token with the highest sequence number from this transaction attempt to the Commit request for this transaction.

.google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value MultiplexedSessionPrecommitToken
Returns
Type Description
ResultSet.Builder

mergeStats(ResultSetStats value)

public ResultSet.Builder mergeStats(ResultSetStats value)

Query plan and execution statistics for the SQL statement that produced this result set. These can be requested by setting ExecuteSqlRequest.query_mode. DML statements always produce stats containing the number of rows modified, unless executed using the ExecuteSqlRequest.QueryMode.PLAN ExecuteSqlRequest.query_mode. Other fields might or might not be populated, based on the ExecuteSqlRequest.query_mode.

.google.spanner.v1.ResultSetStats stats = 3;

Parameter
Name Description
value ResultSetStats
Returns
Type Description
ResultSet.Builder

removeRows(int index)

public ResultSet.Builder removeRows(int index)

Each element in rows is a row whose format is defined by metadata.row_type. The ith element in each row matches the ith field in metadata.row_type. Elements are encoded based on type as described here.

repeated .google.protobuf.ListValue rows = 2;

Parameter
Name Description
index int
Returns
Type Description
ResultSet.Builder

setCacheUpdate(CacheUpdate value)

public ResultSet.Builder setCacheUpdate(CacheUpdate value)

Optional. A cache update expresses a set of changes the client should incorporate into its location cache. The client should discard the changes if they are older than the data it already has. This data can be obtained in response to requests that included a RoutingHint field, but may also be obtained by explicit location-fetching RPCs which may be added in the future.

.google.spanner.v1.CacheUpdate cache_update = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value CacheUpdate
Returns
Type Description
ResultSet.Builder

setCacheUpdate(CacheUpdate.Builder builderForValue)

public ResultSet.Builder setCacheUpdate(CacheUpdate.Builder builderForValue)

Optional. A cache update expresses a set of changes the client should incorporate into its location cache. The client should discard the changes if they are older than the data it already has. This data can be obtained in response to requests that included a RoutingHint field, but may also be obtained by explicit location-fetching RPCs which may be added in the future.

.google.spanner.v1.CacheUpdate cache_update = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue CacheUpdate.Builder
Returns
Type Description
ResultSet.Builder

setMetadata(ResultSetMetadata value)

public ResultSet.Builder setMetadata(ResultSetMetadata value)

Metadata about the result set, such as row type information.

.google.spanner.v1.ResultSetMetadata metadata = 1;

Parameter
Name Description
value ResultSetMetadata
Returns
Type Description
ResultSet.Builder

setMetadata(ResultSetMetadata.Builder builderForValue)

public ResultSet.Builder setMetadata(ResultSetMetadata.Builder builderForValue)

Metadata about the result set, such as row type information.

.google.spanner.v1.ResultSetMetadata metadata = 1;

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

setPrecommitToken(MultiplexedSessionPrecommitToken value)

public ResultSet.Builder setPrecommitToken(MultiplexedSessionPrecommitToken value)

Optional. A precommit token is included if the read-write transaction is on a multiplexed session. Pass the precommit token with the highest sequence number from this transaction attempt to the Commit request for this transaction.

.google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value MultiplexedSessionPrecommitToken
Returns
Type Description
ResultSet.Builder

setPrecommitToken(MultiplexedSessionPrecommitToken.Builder builderForValue)

public ResultSet.Builder setPrecommitToken(MultiplexedSessionPrecommitToken.Builder builderForValue)

Optional. A precommit token is included if the read-write transaction is on a multiplexed session. Pass the precommit token with the highest sequence number from this transaction attempt to the Commit request for this transaction.

.google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue MultiplexedSessionPrecommitToken.Builder
Returns
Type Description
ResultSet.Builder

setRows(int index, ListValue value)

public ResultSet.Builder setRows(int index, ListValue value)

Each element in rows is a row whose format is defined by metadata.row_type. The ith element in each row matches the ith field in metadata.row_type. Elements are encoded based on type as described here.

repeated .google.protobuf.ListValue rows = 2;

Parameters
Name Description
index int
value ListValue
Returns
Type Description
ResultSet.Builder

setRows(int index, ListValue.Builder builderForValue)

public ResultSet.Builder setRows(int index, ListValue.Builder builderForValue)

Each element in rows is a row whose format is defined by metadata.row_type. The ith element in each row matches the ith field in metadata.row_type. Elements are encoded based on type as described here.

repeated .google.protobuf.ListValue rows = 2;

Parameters
Name Description
index int
builderForValue Builder
Returns
Type Description
ResultSet.Builder

setStats(ResultSetStats value)

public ResultSet.Builder setStats(ResultSetStats value)

Query plan and execution statistics for the SQL statement that produced this result set. These can be requested by setting ExecuteSqlRequest.query_mode. DML statements always produce stats containing the number of rows modified, unless executed using the ExecuteSqlRequest.QueryMode.PLAN ExecuteSqlRequest.query_mode. Other fields might or might not be populated, based on the ExecuteSqlRequest.query_mode.

.google.spanner.v1.ResultSetStats stats = 3;

Parameter
Name Description
value ResultSetStats
Returns
Type Description
ResultSet.Builder

setStats(ResultSetStats.Builder builderForValue)

public ResultSet.Builder setStats(ResultSetStats.Builder builderForValue)

Query plan and execution statistics for the SQL statement that produced this result set. These can be requested by setting ExecuteSqlRequest.query_mode. DML statements always produce stats containing the number of rows modified, unless executed using the ExecuteSqlRequest.QueryMode.PLAN ExecuteSqlRequest.query_mode. Other fields might or might not be populated, based on the ExecuteSqlRequest.query_mode.

.google.spanner.v1.ResultSetStats stats = 3;

Parameter
Name Description
builderForValue ResultSetStats.Builder
Returns
Type Description
ResultSet.Builder