Class SpannerActionOutcome.Builder (6.71.0)

public static final class SpannerActionOutcome.Builder extends GeneratedMessageV3.Builder<SpannerActionOutcome.Builder> implements SpannerActionOutcomeOrBuilder

SpannerActionOutcome defines a result of execution of a single SpannerAction.

Protobuf type google.spanner.executor.v1.SpannerActionOutcome

Static Methods

getDescriptor()

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

Methods

addAllChangeStreamRecords(Iterable<? extends ChangeStreamRecord> values)

public SpannerActionOutcome.Builder addAllChangeStreamRecords(Iterable<? extends ChangeStreamRecord> values)

Change stream records returned by a change stream query.

repeated .google.spanner.executor.v1.ChangeStreamRecord change_stream_records = 10;

Parameter
Name Description
values Iterable<? extends com.google.spanner.executor.v1.ChangeStreamRecord>
Returns
Type Description
SpannerActionOutcome.Builder

addAllDbPartition(Iterable<? extends BatchPartition> values)

public SpannerActionOutcome.Builder addAllDbPartition(Iterable<? extends BatchPartition> values)

Generated database partitions (result of a GenetageDbPartitionsForReadAction/GenerateDbPartitionsForQueryAction).

repeated .google.spanner.executor.v1.BatchPartition db_partition = 7;

Parameter
Name Description
values Iterable<? extends com.google.spanner.executor.v1.BatchPartition>
Returns
Type Description
SpannerActionOutcome.Builder

addAllDmlRowsModified(Iterable<? extends Long> values)

public SpannerActionOutcome.Builder addAllDmlRowsModified(Iterable<? extends Long> values)

Stores rows modified by query in single DML or batch DML action. In case of batch DML action, stores 0 as row count of errored DML query.

repeated int64 dml_rows_modified = 9;

Parameter
Name Description
values Iterable<? extends java.lang.Long>

The dmlRowsModified to add.

Returns
Type Description
SpannerActionOutcome.Builder

This builder for chaining.

addChangeStreamRecords(ChangeStreamRecord value)

public SpannerActionOutcome.Builder addChangeStreamRecords(ChangeStreamRecord value)

Change stream records returned by a change stream query.

repeated .google.spanner.executor.v1.ChangeStreamRecord change_stream_records = 10;

Parameter
Name Description
value ChangeStreamRecord
Returns
Type Description
SpannerActionOutcome.Builder

addChangeStreamRecords(ChangeStreamRecord.Builder builderForValue)

public SpannerActionOutcome.Builder addChangeStreamRecords(ChangeStreamRecord.Builder builderForValue)

Change stream records returned by a change stream query.

repeated .google.spanner.executor.v1.ChangeStreamRecord change_stream_records = 10;

Parameter
Name Description
builderForValue ChangeStreamRecord.Builder
Returns
Type Description
SpannerActionOutcome.Builder

addChangeStreamRecords(int index, ChangeStreamRecord value)

public SpannerActionOutcome.Builder addChangeStreamRecords(int index, ChangeStreamRecord value)

Change stream records returned by a change stream query.

repeated .google.spanner.executor.v1.ChangeStreamRecord change_stream_records = 10;

Parameters
Name Description
index int
value ChangeStreamRecord
Returns
Type Description
SpannerActionOutcome.Builder

addChangeStreamRecords(int index, ChangeStreamRecord.Builder builderForValue)

public SpannerActionOutcome.Builder addChangeStreamRecords(int index, ChangeStreamRecord.Builder builderForValue)

Change stream records returned by a change stream query.

repeated .google.spanner.executor.v1.ChangeStreamRecord change_stream_records = 10;

Parameters
Name Description
index int
builderForValue ChangeStreamRecord.Builder
Returns
Type Description
SpannerActionOutcome.Builder

addChangeStreamRecordsBuilder()

public ChangeStreamRecord.Builder addChangeStreamRecordsBuilder()

Change stream records returned by a change stream query.

repeated .google.spanner.executor.v1.ChangeStreamRecord change_stream_records = 10;

Returns
Type Description
ChangeStreamRecord.Builder

addChangeStreamRecordsBuilder(int index)

public ChangeStreamRecord.Builder addChangeStreamRecordsBuilder(int index)

Change stream records returned by a change stream query.

repeated .google.spanner.executor.v1.ChangeStreamRecord change_stream_records = 10;

Parameter
Name Description
index int
Returns
Type Description
ChangeStreamRecord.Builder

addDbPartition(BatchPartition value)

public SpannerActionOutcome.Builder addDbPartition(BatchPartition value)

Generated database partitions (result of a GenetageDbPartitionsForReadAction/GenerateDbPartitionsForQueryAction).

repeated .google.spanner.executor.v1.BatchPartition db_partition = 7;

Parameter
Name Description
value BatchPartition
Returns
Type Description
SpannerActionOutcome.Builder

addDbPartition(BatchPartition.Builder builderForValue)

public SpannerActionOutcome.Builder addDbPartition(BatchPartition.Builder builderForValue)

Generated database partitions (result of a GenetageDbPartitionsForReadAction/GenerateDbPartitionsForQueryAction).

repeated .google.spanner.executor.v1.BatchPartition db_partition = 7;

Parameter
Name Description
builderForValue BatchPartition.Builder
Returns
Type Description
SpannerActionOutcome.Builder

addDbPartition(int index, BatchPartition value)

public SpannerActionOutcome.Builder addDbPartition(int index, BatchPartition value)

Generated database partitions (result of a GenetageDbPartitionsForReadAction/GenerateDbPartitionsForQueryAction).

repeated .google.spanner.executor.v1.BatchPartition db_partition = 7;

Parameters
Name Description
index int
value BatchPartition
Returns
Type Description
SpannerActionOutcome.Builder

addDbPartition(int index, BatchPartition.Builder builderForValue)

public SpannerActionOutcome.Builder addDbPartition(int index, BatchPartition.Builder builderForValue)

Generated database partitions (result of a GenetageDbPartitionsForReadAction/GenerateDbPartitionsForQueryAction).

repeated .google.spanner.executor.v1.BatchPartition db_partition = 7;

Parameters
Name Description
index int
builderForValue BatchPartition.Builder
Returns
Type Description
SpannerActionOutcome.Builder

addDbPartitionBuilder()

public BatchPartition.Builder addDbPartitionBuilder()

Generated database partitions (result of a GenetageDbPartitionsForReadAction/GenerateDbPartitionsForQueryAction).

repeated .google.spanner.executor.v1.BatchPartition db_partition = 7;

Returns
Type Description
BatchPartition.Builder

addDbPartitionBuilder(int index)

public BatchPartition.Builder addDbPartitionBuilder(int index)

Generated database partitions (result of a GenetageDbPartitionsForReadAction/GenerateDbPartitionsForQueryAction).

repeated .google.spanner.executor.v1.BatchPartition db_partition = 7;

Parameter
Name Description
index int
Returns
Type Description
BatchPartition.Builder

addDmlRowsModified(long value)

public SpannerActionOutcome.Builder addDmlRowsModified(long value)

Stores rows modified by query in single DML or batch DML action. In case of batch DML action, stores 0 as row count of errored DML query.

repeated int64 dml_rows_modified = 9;

Parameter
Name Description
value long

The dmlRowsModified to add.

Returns
Type Description
SpannerActionOutcome.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public SpannerActionOutcome build()
Returns
Type Description
SpannerActionOutcome

buildPartial()

public SpannerActionOutcome buildPartial()
Returns
Type Description
SpannerActionOutcome

clear()

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

clearAdminResult()

public SpannerActionOutcome.Builder clearAdminResult()

Result of admin related actions.

optional .google.spanner.executor.v1.AdminResult admin_result = 8;

Returns
Type Description
SpannerActionOutcome.Builder

clearBatchTxnId()

public SpannerActionOutcome.Builder clearBatchTxnId()

In successful StartBatchTransactionAction outcomes, this contains the ID of the transaction.

optional bytes batch_txn_id = 6;

Returns
Type Description
SpannerActionOutcome.Builder

This builder for chaining.

clearChangeStreamRecords()

public SpannerActionOutcome.Builder clearChangeStreamRecords()

Change stream records returned by a change stream query.

repeated .google.spanner.executor.v1.ChangeStreamRecord change_stream_records = 10;

Returns
Type Description
SpannerActionOutcome.Builder

clearCommitTime()

public SpannerActionOutcome.Builder clearCommitTime()

Transaction timestamp. It must be set for successful committed actions.

optional .google.protobuf.Timestamp commit_time = 2;

Returns
Type Description
SpannerActionOutcome.Builder

clearDbPartition()

public SpannerActionOutcome.Builder clearDbPartition()

Generated database partitions (result of a GenetageDbPartitionsForReadAction/GenerateDbPartitionsForQueryAction).

repeated .google.spanner.executor.v1.BatchPartition db_partition = 7;

Returns
Type Description
SpannerActionOutcome.Builder

clearDmlRowsModified()

public SpannerActionOutcome.Builder clearDmlRowsModified()

Stores rows modified by query in single DML or batch DML action. In case of batch DML action, stores 0 as row count of errored DML query.

repeated int64 dml_rows_modified = 9;

Returns
Type Description
SpannerActionOutcome.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearQueryResult()

public SpannerActionOutcome.Builder clearQueryResult()

Result of a Query. This field must be set for Queries even if no rows were read.

optional .google.spanner.executor.v1.QueryResult query_result = 4;

Returns
Type Description
SpannerActionOutcome.Builder

clearReadResult()

public SpannerActionOutcome.Builder clearReadResult()

Result of a ReadAction. This field must be set for ReadActions even if no rows were read.

optional .google.spanner.executor.v1.ReadResult read_result = 3;

Returns
Type Description
SpannerActionOutcome.Builder

clearStatus()

public SpannerActionOutcome.Builder clearStatus()

If an outcome is split into multiple parts, status will be set only in the last part.

optional .google.rpc.Status status = 1;

Returns
Type Description
SpannerActionOutcome.Builder

clearTransactionRestarted()

public SpannerActionOutcome.Builder clearTransactionRestarted()

This bit indicates that Spanner has restarted the current transaction. It means that the client should replay all the reads and writes. Setting it to true is only valid in the context of a read-write transaction, as an outcome of a committing FinishTransactionAction.

optional bool transaction_restarted = 5;

Returns
Type Description
SpannerActionOutcome.Builder

This builder for chaining.

clone()

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

getAdminResult()

public AdminResult getAdminResult()

Result of admin related actions.

optional .google.spanner.executor.v1.AdminResult admin_result = 8;

Returns
Type Description
AdminResult

The adminResult.

getAdminResultBuilder()

public AdminResult.Builder getAdminResultBuilder()

Result of admin related actions.

optional .google.spanner.executor.v1.AdminResult admin_result = 8;

Returns
Type Description
AdminResult.Builder

getAdminResultOrBuilder()

public AdminResultOrBuilder getAdminResultOrBuilder()

Result of admin related actions.

optional .google.spanner.executor.v1.AdminResult admin_result = 8;

Returns
Type Description
AdminResultOrBuilder

getBatchTxnId()

public ByteString getBatchTxnId()

In successful StartBatchTransactionAction outcomes, this contains the ID of the transaction.

optional bytes batch_txn_id = 6;

Returns
Type Description
ByteString

The batchTxnId.

getChangeStreamRecords(int index)

public ChangeStreamRecord getChangeStreamRecords(int index)

Change stream records returned by a change stream query.

repeated .google.spanner.executor.v1.ChangeStreamRecord change_stream_records = 10;

Parameter
Name Description
index int
Returns
Type Description
ChangeStreamRecord

getChangeStreamRecordsBuilder(int index)

public ChangeStreamRecord.Builder getChangeStreamRecordsBuilder(int index)

Change stream records returned by a change stream query.

repeated .google.spanner.executor.v1.ChangeStreamRecord change_stream_records = 10;

Parameter
Name Description
index int
Returns
Type Description
ChangeStreamRecord.Builder

getChangeStreamRecordsBuilderList()

public List<ChangeStreamRecord.Builder> getChangeStreamRecordsBuilderList()

Change stream records returned by a change stream query.

repeated .google.spanner.executor.v1.ChangeStreamRecord change_stream_records = 10;

Returns
Type Description
List<Builder>

getChangeStreamRecordsCount()

public int getChangeStreamRecordsCount()

Change stream records returned by a change stream query.

repeated .google.spanner.executor.v1.ChangeStreamRecord change_stream_records = 10;

Returns
Type Description
int

getChangeStreamRecordsList()

public List<ChangeStreamRecord> getChangeStreamRecordsList()

Change stream records returned by a change stream query.

repeated .google.spanner.executor.v1.ChangeStreamRecord change_stream_records = 10;

Returns
Type Description
List<ChangeStreamRecord>

getChangeStreamRecordsOrBuilder(int index)

public ChangeStreamRecordOrBuilder getChangeStreamRecordsOrBuilder(int index)

Change stream records returned by a change stream query.

repeated .google.spanner.executor.v1.ChangeStreamRecord change_stream_records = 10;

Parameter
Name Description
index int
Returns
Type Description
ChangeStreamRecordOrBuilder

getChangeStreamRecordsOrBuilderList()

public List<? extends ChangeStreamRecordOrBuilder> getChangeStreamRecordsOrBuilderList()

Change stream records returned by a change stream query.

repeated .google.spanner.executor.v1.ChangeStreamRecord change_stream_records = 10;

Returns
Type Description
List<? extends com.google.spanner.executor.v1.ChangeStreamRecordOrBuilder>

getCommitTime()

public Timestamp getCommitTime()

Transaction timestamp. It must be set for successful committed actions.

optional .google.protobuf.Timestamp commit_time = 2;

Returns
Type Description
Timestamp

The commitTime.

getCommitTimeBuilder()

public Timestamp.Builder getCommitTimeBuilder()

Transaction timestamp. It must be set for successful committed actions.

optional .google.protobuf.Timestamp commit_time = 2;

Returns
Type Description
Builder

getCommitTimeOrBuilder()

public TimestampOrBuilder getCommitTimeOrBuilder()

Transaction timestamp. It must be set for successful committed actions.

optional .google.protobuf.Timestamp commit_time = 2;

Returns
Type Description
TimestampOrBuilder

getDbPartition(int index)

public BatchPartition getDbPartition(int index)

Generated database partitions (result of a GenetageDbPartitionsForReadAction/GenerateDbPartitionsForQueryAction).

repeated .google.spanner.executor.v1.BatchPartition db_partition = 7;

Parameter
Name Description
index int
Returns
Type Description
BatchPartition

getDbPartitionBuilder(int index)

public BatchPartition.Builder getDbPartitionBuilder(int index)

Generated database partitions (result of a GenetageDbPartitionsForReadAction/GenerateDbPartitionsForQueryAction).

repeated .google.spanner.executor.v1.BatchPartition db_partition = 7;

Parameter
Name Description
index int
Returns
Type Description
BatchPartition.Builder

getDbPartitionBuilderList()

public List<BatchPartition.Builder> getDbPartitionBuilderList()

Generated database partitions (result of a GenetageDbPartitionsForReadAction/GenerateDbPartitionsForQueryAction).

repeated .google.spanner.executor.v1.BatchPartition db_partition = 7;

Returns
Type Description
List<Builder>

getDbPartitionCount()

public int getDbPartitionCount()

Generated database partitions (result of a GenetageDbPartitionsForReadAction/GenerateDbPartitionsForQueryAction).

repeated .google.spanner.executor.v1.BatchPartition db_partition = 7;

Returns
Type Description
int

getDbPartitionList()

public List<BatchPartition> getDbPartitionList()

Generated database partitions (result of a GenetageDbPartitionsForReadAction/GenerateDbPartitionsForQueryAction).

repeated .google.spanner.executor.v1.BatchPartition db_partition = 7;

Returns
Type Description
List<BatchPartition>

getDbPartitionOrBuilder(int index)

public BatchPartitionOrBuilder getDbPartitionOrBuilder(int index)

Generated database partitions (result of a GenetageDbPartitionsForReadAction/GenerateDbPartitionsForQueryAction).

repeated .google.spanner.executor.v1.BatchPartition db_partition = 7;

Parameter
Name Description
index int
Returns
Type Description
BatchPartitionOrBuilder

getDbPartitionOrBuilderList()

public List<? extends BatchPartitionOrBuilder> getDbPartitionOrBuilderList()

Generated database partitions (result of a GenetageDbPartitionsForReadAction/GenerateDbPartitionsForQueryAction).

repeated .google.spanner.executor.v1.BatchPartition db_partition = 7;

Returns
Type Description
List<? extends com.google.spanner.executor.v1.BatchPartitionOrBuilder>

getDefaultInstanceForType()

public SpannerActionOutcome getDefaultInstanceForType()
Returns
Type Description
SpannerActionOutcome

getDescriptorForType()

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

getDmlRowsModified(int index)

public long getDmlRowsModified(int index)

Stores rows modified by query in single DML or batch DML action. In case of batch DML action, stores 0 as row count of errored DML query.

repeated int64 dml_rows_modified = 9;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
long

The dmlRowsModified at the given index.

getDmlRowsModifiedCount()

public int getDmlRowsModifiedCount()

Stores rows modified by query in single DML or batch DML action. In case of batch DML action, stores 0 as row count of errored DML query.

repeated int64 dml_rows_modified = 9;

Returns
Type Description
int

The count of dmlRowsModified.

getDmlRowsModifiedList()

public List<Long> getDmlRowsModifiedList()

Stores rows modified by query in single DML or batch DML action. In case of batch DML action, stores 0 as row count of errored DML query.

repeated int64 dml_rows_modified = 9;

Returns
Type Description
List<Long>

A list containing the dmlRowsModified.

getQueryResult()

public QueryResult getQueryResult()

Result of a Query. This field must be set for Queries even if no rows were read.

optional .google.spanner.executor.v1.QueryResult query_result = 4;

Returns
Type Description
QueryResult

The queryResult.

getQueryResultBuilder()

public QueryResult.Builder getQueryResultBuilder()

Result of a Query. This field must be set for Queries even if no rows were read.

optional .google.spanner.executor.v1.QueryResult query_result = 4;

Returns
Type Description
QueryResult.Builder

getQueryResultOrBuilder()

public QueryResultOrBuilder getQueryResultOrBuilder()

Result of a Query. This field must be set for Queries even if no rows were read.

optional .google.spanner.executor.v1.QueryResult query_result = 4;

Returns
Type Description
QueryResultOrBuilder

getReadResult()

public ReadResult getReadResult()

Result of a ReadAction. This field must be set for ReadActions even if no rows were read.

optional .google.spanner.executor.v1.ReadResult read_result = 3;

Returns
Type Description
ReadResult

The readResult.

getReadResultBuilder()

public ReadResult.Builder getReadResultBuilder()

Result of a ReadAction. This field must be set for ReadActions even if no rows were read.

optional .google.spanner.executor.v1.ReadResult read_result = 3;

Returns
Type Description
ReadResult.Builder

getReadResultOrBuilder()

public ReadResultOrBuilder getReadResultOrBuilder()

Result of a ReadAction. This field must be set for ReadActions even if no rows were read.

optional .google.spanner.executor.v1.ReadResult read_result = 3;

Returns
Type Description
ReadResultOrBuilder

getStatus()

public Status getStatus()

If an outcome is split into multiple parts, status will be set only in the last part.

optional .google.rpc.Status status = 1;

Returns
Type Description
com.google.rpc.Status

The status.

getStatusBuilder()

public Status.Builder getStatusBuilder()

If an outcome is split into multiple parts, status will be set only in the last part.

optional .google.rpc.Status status = 1;

Returns
Type Description
com.google.rpc.Status.Builder

getStatusOrBuilder()

public StatusOrBuilder getStatusOrBuilder()

If an outcome is split into multiple parts, status will be set only in the last part.

optional .google.rpc.Status status = 1;

Returns
Type Description
com.google.rpc.StatusOrBuilder

getTransactionRestarted()

public boolean getTransactionRestarted()

This bit indicates that Spanner has restarted the current transaction. It means that the client should replay all the reads and writes. Setting it to true is only valid in the context of a read-write transaction, as an outcome of a committing FinishTransactionAction.

optional bool transaction_restarted = 5;

Returns
Type Description
boolean

The transactionRestarted.

hasAdminResult()

public boolean hasAdminResult()

Result of admin related actions.

optional .google.spanner.executor.v1.AdminResult admin_result = 8;

Returns
Type Description
boolean

Whether the adminResult field is set.

hasBatchTxnId()

public boolean hasBatchTxnId()

In successful StartBatchTransactionAction outcomes, this contains the ID of the transaction.

optional bytes batch_txn_id = 6;

Returns
Type Description
boolean

Whether the batchTxnId field is set.

hasCommitTime()

public boolean hasCommitTime()

Transaction timestamp. It must be set for successful committed actions.

optional .google.protobuf.Timestamp commit_time = 2;

Returns
Type Description
boolean

Whether the commitTime field is set.

hasQueryResult()

public boolean hasQueryResult()

Result of a Query. This field must be set for Queries even if no rows were read.

optional .google.spanner.executor.v1.QueryResult query_result = 4;

Returns
Type Description
boolean

Whether the queryResult field is set.

hasReadResult()

public boolean hasReadResult()

Result of a ReadAction. This field must be set for ReadActions even if no rows were read.

optional .google.spanner.executor.v1.ReadResult read_result = 3;

Returns
Type Description
boolean

Whether the readResult field is set.

hasStatus()

public boolean hasStatus()

If an outcome is split into multiple parts, status will be set only in the last part.

optional .google.rpc.Status status = 1;

Returns
Type Description
boolean

Whether the status field is set.

hasTransactionRestarted()

public boolean hasTransactionRestarted()

This bit indicates that Spanner has restarted the current transaction. It means that the client should replay all the reads and writes. Setting it to true is only valid in the context of a read-write transaction, as an outcome of a committing FinishTransactionAction.

optional bool transaction_restarted = 5;

Returns
Type Description
boolean

Whether the transactionRestarted field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAdminResult(AdminResult value)

public SpannerActionOutcome.Builder mergeAdminResult(AdminResult value)

Result of admin related actions.

optional .google.spanner.executor.v1.AdminResult admin_result = 8;

Parameter
Name Description
value AdminResult
Returns
Type Description
SpannerActionOutcome.Builder

mergeCommitTime(Timestamp value)

public SpannerActionOutcome.Builder mergeCommitTime(Timestamp value)

Transaction timestamp. It must be set for successful committed actions.

optional .google.protobuf.Timestamp commit_time = 2;

Parameter
Name Description
value Timestamp
Returns
Type Description
SpannerActionOutcome.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeFrom(SpannerActionOutcome other)

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

mergeQueryResult(QueryResult value)

public SpannerActionOutcome.Builder mergeQueryResult(QueryResult value)

Result of a Query. This field must be set for Queries even if no rows were read.

optional .google.spanner.executor.v1.QueryResult query_result = 4;

Parameter
Name Description
value QueryResult
Returns
Type Description
SpannerActionOutcome.Builder

mergeReadResult(ReadResult value)

public SpannerActionOutcome.Builder mergeReadResult(ReadResult value)

Result of a ReadAction. This field must be set for ReadActions even if no rows were read.

optional .google.spanner.executor.v1.ReadResult read_result = 3;

Parameter
Name Description
value ReadResult
Returns
Type Description
SpannerActionOutcome.Builder

mergeStatus(Status value)

public SpannerActionOutcome.Builder mergeStatus(Status value)

If an outcome is split into multiple parts, status will be set only in the last part.

optional .google.rpc.Status status = 1;

Parameter
Name Description
value com.google.rpc.Status
Returns
Type Description
SpannerActionOutcome.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

removeChangeStreamRecords(int index)

public SpannerActionOutcome.Builder removeChangeStreamRecords(int index)

Change stream records returned by a change stream query.

repeated .google.spanner.executor.v1.ChangeStreamRecord change_stream_records = 10;

Parameter
Name Description
index int
Returns
Type Description
SpannerActionOutcome.Builder

removeDbPartition(int index)

public SpannerActionOutcome.Builder removeDbPartition(int index)

Generated database partitions (result of a GenetageDbPartitionsForReadAction/GenerateDbPartitionsForQueryAction).

repeated .google.spanner.executor.v1.BatchPartition db_partition = 7;

Parameter
Name Description
index int
Returns
Type Description
SpannerActionOutcome.Builder

setAdminResult(AdminResult value)

public SpannerActionOutcome.Builder setAdminResult(AdminResult value)

Result of admin related actions.

optional .google.spanner.executor.v1.AdminResult admin_result = 8;

Parameter
Name Description
value AdminResult
Returns
Type Description
SpannerActionOutcome.Builder

setAdminResult(AdminResult.Builder builderForValue)

public SpannerActionOutcome.Builder setAdminResult(AdminResult.Builder builderForValue)

Result of admin related actions.

optional .google.spanner.executor.v1.AdminResult admin_result = 8;

Parameter
Name Description
builderForValue AdminResult.Builder
Returns
Type Description
SpannerActionOutcome.Builder

setBatchTxnId(ByteString value)

public SpannerActionOutcome.Builder setBatchTxnId(ByteString value)

In successful StartBatchTransactionAction outcomes, this contains the ID of the transaction.

optional bytes batch_txn_id = 6;

Parameter
Name Description
value ByteString

The batchTxnId to set.

Returns
Type Description
SpannerActionOutcome.Builder

This builder for chaining.

setChangeStreamRecords(int index, ChangeStreamRecord value)

public SpannerActionOutcome.Builder setChangeStreamRecords(int index, ChangeStreamRecord value)

Change stream records returned by a change stream query.

repeated .google.spanner.executor.v1.ChangeStreamRecord change_stream_records = 10;

Parameters
Name Description
index int
value ChangeStreamRecord
Returns
Type Description
SpannerActionOutcome.Builder

setChangeStreamRecords(int index, ChangeStreamRecord.Builder builderForValue)

public SpannerActionOutcome.Builder setChangeStreamRecords(int index, ChangeStreamRecord.Builder builderForValue)

Change stream records returned by a change stream query.

repeated .google.spanner.executor.v1.ChangeStreamRecord change_stream_records = 10;

Parameters
Name Description
index int
builderForValue ChangeStreamRecord.Builder
Returns
Type Description
SpannerActionOutcome.Builder

setCommitTime(Timestamp value)

public SpannerActionOutcome.Builder setCommitTime(Timestamp value)

Transaction timestamp. It must be set for successful committed actions.

optional .google.protobuf.Timestamp commit_time = 2;

Parameter
Name Description
value Timestamp
Returns
Type Description
SpannerActionOutcome.Builder

setCommitTime(Timestamp.Builder builderForValue)

public SpannerActionOutcome.Builder setCommitTime(Timestamp.Builder builderForValue)

Transaction timestamp. It must be set for successful committed actions.

optional .google.protobuf.Timestamp commit_time = 2;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
SpannerActionOutcome.Builder

setDbPartition(int index, BatchPartition value)

public SpannerActionOutcome.Builder setDbPartition(int index, BatchPartition value)

Generated database partitions (result of a GenetageDbPartitionsForReadAction/GenerateDbPartitionsForQueryAction).

repeated .google.spanner.executor.v1.BatchPartition db_partition = 7;

Parameters
Name Description
index int
value BatchPartition
Returns
Type Description
SpannerActionOutcome.Builder

setDbPartition(int index, BatchPartition.Builder builderForValue)

public SpannerActionOutcome.Builder setDbPartition(int index, BatchPartition.Builder builderForValue)

Generated database partitions (result of a GenetageDbPartitionsForReadAction/GenerateDbPartitionsForQueryAction).

repeated .google.spanner.executor.v1.BatchPartition db_partition = 7;

Parameters
Name Description
index int
builderForValue BatchPartition.Builder
Returns
Type Description
SpannerActionOutcome.Builder

setDmlRowsModified(int index, long value)

public SpannerActionOutcome.Builder setDmlRowsModified(int index, long value)

Stores rows modified by query in single DML or batch DML action. In case of batch DML action, stores 0 as row count of errored DML query.

repeated int64 dml_rows_modified = 9;

Parameters
Name Description
index int

The index to set the value at.

value long

The dmlRowsModified to set.

Returns
Type Description
SpannerActionOutcome.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setQueryResult(QueryResult value)

public SpannerActionOutcome.Builder setQueryResult(QueryResult value)

Result of a Query. This field must be set for Queries even if no rows were read.

optional .google.spanner.executor.v1.QueryResult query_result = 4;

Parameter
Name Description
value QueryResult
Returns
Type Description
SpannerActionOutcome.Builder

setQueryResult(QueryResult.Builder builderForValue)

public SpannerActionOutcome.Builder setQueryResult(QueryResult.Builder builderForValue)

Result of a Query. This field must be set for Queries even if no rows were read.

optional .google.spanner.executor.v1.QueryResult query_result = 4;

Parameter
Name Description
builderForValue QueryResult.Builder
Returns
Type Description
SpannerActionOutcome.Builder

setReadResult(ReadResult value)

public SpannerActionOutcome.Builder setReadResult(ReadResult value)

Result of a ReadAction. This field must be set for ReadActions even if no rows were read.

optional .google.spanner.executor.v1.ReadResult read_result = 3;

Parameter
Name Description
value ReadResult
Returns
Type Description
SpannerActionOutcome.Builder

setReadResult(ReadResult.Builder builderForValue)

public SpannerActionOutcome.Builder setReadResult(ReadResult.Builder builderForValue)

Result of a ReadAction. This field must be set for ReadActions even if no rows were read.

optional .google.spanner.executor.v1.ReadResult read_result = 3;

Parameter
Name Description
builderForValue ReadResult.Builder
Returns
Type Description
SpannerActionOutcome.Builder

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

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

setStatus(Status value)

public SpannerActionOutcome.Builder setStatus(Status value)

If an outcome is split into multiple parts, status will be set only in the last part.

optional .google.rpc.Status status = 1;

Parameter
Name Description
value com.google.rpc.Status
Returns
Type Description
SpannerActionOutcome.Builder

setStatus(Status.Builder builderForValue)

public SpannerActionOutcome.Builder setStatus(Status.Builder builderForValue)

If an outcome is split into multiple parts, status will be set only in the last part.

optional .google.rpc.Status status = 1;

Parameter
Name Description
builderForValue com.google.rpc.Status.Builder
Returns
Type Description
SpannerActionOutcome.Builder

setTransactionRestarted(boolean value)

public SpannerActionOutcome.Builder setTransactionRestarted(boolean value)

This bit indicates that Spanner has restarted the current transaction. It means that the client should replay all the reads and writes. Setting it to true is only valid in the context of a read-write transaction, as an outcome of a committing FinishTransactionAction.

optional bool transaction_restarted = 5;

Parameter
Name Description
value boolean

The transactionRestarted to set.

Returns
Type Description
SpannerActionOutcome.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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