Interface SpannerActionOutcomeOrBuilder (6.65.1)

public interface SpannerActionOutcomeOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAdminResult()

public abstract AdminResult getAdminResult()

Result of admin related actions.

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

Returns
Type Description
AdminResult

The adminResult.

getAdminResultOrBuilder()

public abstract AdminResultOrBuilder getAdminResultOrBuilder()

Result of admin related actions.

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

Returns
Type Description
AdminResultOrBuilder

getBatchTxnId()

public abstract 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 abstract 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

getChangeStreamRecordsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getCommitTimeOrBuilder()

public abstract 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 abstract 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

getDbPartitionCount()

public abstract 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 abstract 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 abstract 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 abstract 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>

getDmlRowsModified(int index)

public abstract 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 abstract 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 abstract 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 abstract 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.

getQueryResultOrBuilder()

public abstract 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 abstract 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.

getReadResultOrBuilder()

public abstract 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 abstract 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.

getStatusOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.