Class SpannerActionOutcome (6.66.0)

public final class SpannerActionOutcome extends GeneratedMessageV3 implements SpannerActionOutcomeOrBuilder

SpannerActionOutcome defines a result of execution of a single SpannerAction.

Protobuf type google.spanner.executor.v1.SpannerActionOutcome

Static Fields

ADMIN_RESULT_FIELD_NUMBER

public static final int ADMIN_RESULT_FIELD_NUMBER
Field Value
Type Description
int

BATCH_TXN_ID_FIELD_NUMBER

public static final int BATCH_TXN_ID_FIELD_NUMBER
Field Value
Type Description
int

CHANGE_STREAM_RECORDS_FIELD_NUMBER

public static final int CHANGE_STREAM_RECORDS_FIELD_NUMBER
Field Value
Type Description
int

COMMIT_TIME_FIELD_NUMBER

public static final int COMMIT_TIME_FIELD_NUMBER
Field Value
Type Description
int

DB_PARTITION_FIELD_NUMBER

public static final int DB_PARTITION_FIELD_NUMBER
Field Value
Type Description
int

DML_ROWS_MODIFIED_FIELD_NUMBER

public static final int DML_ROWS_MODIFIED_FIELD_NUMBER
Field Value
Type Description
int

QUERY_RESULT_FIELD_NUMBER

public static final int QUERY_RESULT_FIELD_NUMBER
Field Value
Type Description
int

READ_RESULT_FIELD_NUMBER

public static final int READ_RESULT_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

TRANSACTION_RESTARTED_FIELD_NUMBER

public static final int TRANSACTION_RESTARTED_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SpannerActionOutcome getDefaultInstance()
Returns
Type Description
SpannerActionOutcome

getDescriptor()

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

newBuilder()

public static SpannerActionOutcome.Builder newBuilder()
Returns
Type Description
SpannerActionOutcome.Builder

newBuilder(SpannerActionOutcome prototype)

public static SpannerActionOutcome.Builder newBuilder(SpannerActionOutcome prototype)
Parameter
Name Description
prototype SpannerActionOutcome
Returns
Type Description
SpannerActionOutcome.Builder

parseDelimitedFrom(InputStream input)

public static SpannerActionOutcome parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SpannerActionOutcome
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SpannerActionOutcome parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SpannerActionOutcome
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SpannerActionOutcome parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SpannerActionOutcome
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SpannerActionOutcome parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SpannerActionOutcome
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SpannerActionOutcome parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SpannerActionOutcome
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SpannerActionOutcome parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SpannerActionOutcome
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SpannerActionOutcome parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SpannerActionOutcome
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SpannerActionOutcome parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SpannerActionOutcome
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SpannerActionOutcome parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SpannerActionOutcome
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SpannerActionOutcome parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SpannerActionOutcome
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SpannerActionOutcome parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SpannerActionOutcome
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SpannerActionOutcome parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SpannerActionOutcome
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SpannerActionOutcome> parser()
Returns
Type Description
Parser<SpannerActionOutcome>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.

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

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.

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

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

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.

getParserForType()

public Parser<SpannerActionOutcome> getParserForType()
Returns
Type Description
Parser<SpannerActionOutcome>
Overrides

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.

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.

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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