Package com.google.spanner.executor.v1

Class SpannerActionOutcome

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.spanner.executor.v1.SpannerActionOutcome
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SpannerActionOutcomeOrBuilder, Serializable
public final class SpannerActionOutcome extends com.google.protobuf.GeneratedMessageV3 implements SpannerActionOutcomeOrBuilder
 SpannerActionOutcome defines a result of execution of a single SpannerAction.
Protobuf type google.spanner.executor.v1.SpannerActionOutcome
See Also:

  • Field Details

    • STATUS_FIELD_NUMBER

      public static final int STATUS_FIELD_NUMBER
      See Also:

    • COMMIT_TIME_FIELD_NUMBER

      public static final int COMMIT_TIME_FIELD_NUMBER
      See Also:

    • READ_RESULT_FIELD_NUMBER

      public static final int READ_RESULT_FIELD_NUMBER
      See Also:

    • QUERY_RESULT_FIELD_NUMBER

      public static final int QUERY_RESULT_FIELD_NUMBER
      See Also:

    • TRANSACTION_RESTARTED_FIELD_NUMBER

      public static final int TRANSACTION_RESTARTED_FIELD_NUMBER
      See Also:

    • BATCH_TXN_ID_FIELD_NUMBER

      public static final int BATCH_TXN_ID_FIELD_NUMBER
      See Also:

    • DB_PARTITION_FIELD_NUMBER

      public static final int DB_PARTITION_FIELD_NUMBER
      See Also:

    • ADMIN_RESULT_FIELD_NUMBER

      public static final int ADMIN_RESULT_FIELD_NUMBER
      See Also:

    • DML_ROWS_MODIFIED_FIELD_NUMBER

      public static final int DML_ROWS_MODIFIED_FIELD_NUMBER
      See Also:

    • CHANGE_STREAM_RECORDS_FIELD_NUMBER

      public static final int CHANGE_STREAM_RECORDS_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • 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;
      Specified by:
      hasStatus in interface SpannerActionOutcomeOrBuilder
      Returns:
      Whether the status field is set.

    • getStatus

      public com.google.rpc.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;
      Specified by:
      getStatus in interface SpannerActionOutcomeOrBuilder
      Returns:
      The status.

    • getStatusOrBuilder

      public com.google.rpc.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;
      Specified by:
      getStatusOrBuilder in interface SpannerActionOutcomeOrBuilder

    • hasCommitTime

      public boolean hasCommitTime()
       Transaction timestamp. It must be set for successful committed actions.
      optional .google.protobuf.Timestamp commit_time = 2;
      Specified by:
      hasCommitTime in interface SpannerActionOutcomeOrBuilder
      Returns:
      Whether the commitTime field is set.

    • getCommitTime

      public com.google.protobuf.Timestamp getCommitTime()
       Transaction timestamp. It must be set for successful committed actions.
      optional .google.protobuf.Timestamp commit_time = 2;
      Specified by:
      getCommitTime in interface SpannerActionOutcomeOrBuilder
      Returns:
      The commitTime.

    • getCommitTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCommitTimeOrBuilder()
       Transaction timestamp. It must be set for successful committed actions.
      optional .google.protobuf.Timestamp commit_time = 2;
      Specified by:
      getCommitTimeOrBuilder in interface SpannerActionOutcomeOrBuilder

    • 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;
      Specified by:
      hasReadResult in interface SpannerActionOutcomeOrBuilder
      Returns:
      Whether the readResult field is set.

    • 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;
      Specified by:
      getReadResult in interface SpannerActionOutcomeOrBuilder
      Returns:
      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;
      Specified by:
      getReadResultOrBuilder in interface SpannerActionOutcomeOrBuilder

    • 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;
      Specified by:
      hasQueryResult in interface SpannerActionOutcomeOrBuilder
      Returns:
      Whether the queryResult field is set.

    • 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;
      Specified by:
      getQueryResult in interface SpannerActionOutcomeOrBuilder
      Returns:
      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;
      Specified by:
      getQueryResultOrBuilder in interface SpannerActionOutcomeOrBuilder

    • 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;
      Specified by:
      hasTransactionRestarted in interface SpannerActionOutcomeOrBuilder
      Returns:
      Whether the transactionRestarted field is set.

    • 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;
      Specified by:
      getTransactionRestarted in interface SpannerActionOutcomeOrBuilder
      Returns:
      The transactionRestarted.

    • hasBatchTxnId

      public boolean hasBatchTxnId()
       In successful StartBatchTransactionAction outcomes, this contains the ID of
 the transaction.
      optional bytes batch_txn_id = 6;
      Specified by:
      hasBatchTxnId in interface SpannerActionOutcomeOrBuilder
      Returns:
      Whether the batchTxnId field is set.

    • getBatchTxnId

      public com.google.protobuf.ByteString getBatchTxnId()
       In successful StartBatchTransactionAction outcomes, this contains the ID of
 the transaction.
      optional bytes batch_txn_id = 6;
      Specified by:
      getBatchTxnId in interface SpannerActionOutcomeOrBuilder
      Returns:
      The batchTxnId.

    • getDbPartitionList

      public List<BatchPartition> getDbPartitionList()
       Generated database partitions (result of a
 GenetageDbPartitionsForReadAction/GenerateDbPartitionsForQueryAction).
      repeated .google.spanner.executor.v1.BatchPartition db_partition = 7;
      Specified by:
      getDbPartitionList in interface SpannerActionOutcomeOrBuilder

    • getDbPartitionOrBuilderList

      public List<? extends BatchPartitionOrBuilder> getDbPartitionOrBuilderList()
       Generated database partitions (result of a
 GenetageDbPartitionsForReadAction/GenerateDbPartitionsForQueryAction).
      repeated .google.spanner.executor.v1.BatchPartition db_partition = 7;
      Specified by:
      getDbPartitionOrBuilderList in interface SpannerActionOutcomeOrBuilder

    • getDbPartitionCount

      public int getDbPartitionCount()
       Generated database partitions (result of a
 GenetageDbPartitionsForReadAction/GenerateDbPartitionsForQueryAction).
      repeated .google.spanner.executor.v1.BatchPartition db_partition = 7;
      Specified by:
      getDbPartitionCount in interface SpannerActionOutcomeOrBuilder

    • getDbPartition

      public BatchPartition getDbPartition(int index)
       Generated database partitions (result of a
 GenetageDbPartitionsForReadAction/GenerateDbPartitionsForQueryAction).
      repeated .google.spanner.executor.v1.BatchPartition db_partition = 7;
      Specified by:
      getDbPartition in interface SpannerActionOutcomeOrBuilder

    • getDbPartitionOrBuilder

      public BatchPartitionOrBuilder getDbPartitionOrBuilder(int index)
       Generated database partitions (result of a
 GenetageDbPartitionsForReadAction/GenerateDbPartitionsForQueryAction).
      repeated .google.spanner.executor.v1.BatchPartition db_partition = 7;
      Specified by:
      getDbPartitionOrBuilder in interface SpannerActionOutcomeOrBuilder

    • hasAdminResult

      public boolean hasAdminResult()
       Result of admin related actions.
      optional .google.spanner.executor.v1.AdminResult admin_result = 8;
      Specified by:
      hasAdminResult in interface SpannerActionOutcomeOrBuilder
      Returns:
      Whether the adminResult field is set.

    • getAdminResult

      public AdminResult getAdminResult()
       Result of admin related actions.
      optional .google.spanner.executor.v1.AdminResult admin_result = 8;
      Specified by:
      getAdminResult in interface SpannerActionOutcomeOrBuilder
      Returns:
      The adminResult.

    • getAdminResultOrBuilder

      public AdminResultOrBuilder getAdminResultOrBuilder()
       Result of admin related actions.
      optional .google.spanner.executor.v1.AdminResult admin_result = 8;
      Specified by:
      getAdminResultOrBuilder in interface SpannerActionOutcomeOrBuilder

    • 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;
      Specified by:
      getDmlRowsModifiedList in interface SpannerActionOutcomeOrBuilder
      Returns:
      A list containing the dmlRowsModified.

    • 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;
      Specified by:
      getDmlRowsModifiedCount in interface SpannerActionOutcomeOrBuilder
      Returns:
      The count of dmlRowsModified.

    • getDmlRowsModified

      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;
      Specified by:
      getDmlRowsModified in interface SpannerActionOutcomeOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The dmlRowsModified at the given index.

    • getChangeStreamRecordsList

      public List<ChangeStreamRecord> getChangeStreamRecordsList()
       Change stream records returned by a change stream query.
      repeated .google.spanner.executor.v1.ChangeStreamRecord change_stream_records = 10;
      Specified by:
      getChangeStreamRecordsList in interface SpannerActionOutcomeOrBuilder

    • 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;
      Specified by:
      getChangeStreamRecordsOrBuilderList in interface SpannerActionOutcomeOrBuilder

    • getChangeStreamRecordsCount

      public int getChangeStreamRecordsCount()
       Change stream records returned by a change stream query.
      repeated .google.spanner.executor.v1.ChangeStreamRecord change_stream_records = 10;
      Specified by:
      getChangeStreamRecordsCount in interface SpannerActionOutcomeOrBuilder

    • getChangeStreamRecords

      public ChangeStreamRecord getChangeStreamRecords(int index)
       Change stream records returned by a change stream query.
      repeated .google.spanner.executor.v1.ChangeStreamRecord change_stream_records = 10;
      Specified by:
      getChangeStreamRecords in interface SpannerActionOutcomeOrBuilder

    • getChangeStreamRecordsOrBuilder

      public ChangeStreamRecordOrBuilder getChangeStreamRecordsOrBuilder(int index)
       Change stream records returned by a change stream query.
      repeated .google.spanner.executor.v1.ChangeStreamRecord change_stream_records = 10;
      Specified by:
      getChangeStreamRecordsOrBuilder in interface SpannerActionOutcomeOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static SpannerActionOutcome parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SpannerActionOutcome parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SpannerActionOutcome parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SpannerActionOutcome parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SpannerActionOutcome parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SpannerActionOutcome parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SpannerActionOutcome parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SpannerActionOutcome parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SpannerActionOutcome parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SpannerActionOutcome parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SpannerActionOutcome parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SpannerActionOutcome parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public SpannerActionOutcome.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static SpannerActionOutcome.Builder newBuilder()

    • newBuilder

      public static SpannerActionOutcome.Builder newBuilder(SpannerActionOutcome prototype)

    • toBuilder

      public SpannerActionOutcome.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected SpannerActionOutcome.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static SpannerActionOutcome getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SpannerActionOutcome> parser()

    • getParserForType

      public com.google.protobuf.Parser<SpannerActionOutcome> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public SpannerActionOutcome getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder