Package com.google.spanner.v1

Class ExecuteBatchDmlResponse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.spanner.v1.ExecuteBatchDmlResponse
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ExecuteBatchDmlResponseOrBuilder, Serializable
@Generated public final class ExecuteBatchDmlResponse extends com.google.protobuf.GeneratedMessage implements ExecuteBatchDmlResponseOrBuilder
 The response for
 [ExecuteBatchDml][google.spanner.v1.Spanner.ExecuteBatchDml]. Contains a list
 of [ResultSet][google.spanner.v1.ResultSet] messages, one for each DML
 statement that has successfully executed, in the same order as the statements
 in the request. If a statement fails, the status in the response body
 identifies the cause of the failure.

 To check for DML statements that failed, use the following approach:

 1. Check the status in the response message. The
 [google.rpc.Code][google.rpc.Code] enum
 value `OK` indicates that all statements were executed successfully.
 2. If the status was not `OK`, check the number of result sets in the
 response. If the response contains `N`
 [ResultSet][google.spanner.v1.ResultSet] messages, then statement `N+1` in
 the request failed.

 Example 1:

 * Request: 5 DML statements, all executed successfully.
 * Response: 5 [ResultSet][google.spanner.v1.ResultSet] messages, with the
 status `OK`.

 Example 2:

 * Request: 5 DML statements. The third statement has a syntax error.
 * Response: 2 [ResultSet][google.spanner.v1.ResultSet] messages, and a syntax
 error (`INVALID_ARGUMENT`)
 status. The number of [ResultSet][google.spanner.v1.ResultSet] messages
 indicates that the third statement failed, and the fourth and fifth
 statements were not executed.
Protobuf type google.spanner.v1.ExecuteBatchDmlResponse
See Also:

  • Field Details

    • RESULT_SETS_FIELD_NUMBER

      public static final int RESULT_SETS_FIELD_NUMBER
      See Also:

    • STATUS_FIELD_NUMBER

      public static final int STATUS_FIELD_NUMBER
      See Also:

    • PRECOMMIT_TOKEN_FIELD_NUMBER

      public static final int PRECOMMIT_TOKEN_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • getResultSetsList

      public List<ResultSet> getResultSetsList()
       One [ResultSet][google.spanner.v1.ResultSet] for each statement in the
 request that ran successfully, in the same order as the statements in the
 request. Each [ResultSet][google.spanner.v1.ResultSet] does not contain any
 rows. The [ResultSetStats][google.spanner.v1.ResultSetStats] in each
 [ResultSet][google.spanner.v1.ResultSet] contain the number of rows
 modified by the statement.

 Only the first [ResultSet][google.spanner.v1.ResultSet] in the response
 contains valid [ResultSetMetadata][google.spanner.v1.ResultSetMetadata].
      repeated .google.spanner.v1.ResultSet result_sets = 1;
      Specified by:
      getResultSetsList in interface ExecuteBatchDmlResponseOrBuilder

    • getResultSetsOrBuilderList

      public List<? extends ResultSetOrBuilder> getResultSetsOrBuilderList()
       One [ResultSet][google.spanner.v1.ResultSet] for each statement in the
 request that ran successfully, in the same order as the statements in the
 request. Each [ResultSet][google.spanner.v1.ResultSet] does not contain any
 rows. The [ResultSetStats][google.spanner.v1.ResultSetStats] in each
 [ResultSet][google.spanner.v1.ResultSet] contain the number of rows
 modified by the statement.

 Only the first [ResultSet][google.spanner.v1.ResultSet] in the response
 contains valid [ResultSetMetadata][google.spanner.v1.ResultSetMetadata].
      repeated .google.spanner.v1.ResultSet result_sets = 1;
      Specified by:
      getResultSetsOrBuilderList in interface ExecuteBatchDmlResponseOrBuilder

    • getResultSetsCount

      public int getResultSetsCount()
       One [ResultSet][google.spanner.v1.ResultSet] for each statement in the
 request that ran successfully, in the same order as the statements in the
 request. Each [ResultSet][google.spanner.v1.ResultSet] does not contain any
 rows. The [ResultSetStats][google.spanner.v1.ResultSetStats] in each
 [ResultSet][google.spanner.v1.ResultSet] contain the number of rows
 modified by the statement.

 Only the first [ResultSet][google.spanner.v1.ResultSet] in the response
 contains valid [ResultSetMetadata][google.spanner.v1.ResultSetMetadata].
      repeated .google.spanner.v1.ResultSet result_sets = 1;
      Specified by:
      getResultSetsCount in interface ExecuteBatchDmlResponseOrBuilder

    • getResultSets

      public ResultSet getResultSets(int index)
       One [ResultSet][google.spanner.v1.ResultSet] for each statement in the
 request that ran successfully, in the same order as the statements in the
 request. Each [ResultSet][google.spanner.v1.ResultSet] does not contain any
 rows. The [ResultSetStats][google.spanner.v1.ResultSetStats] in each
 [ResultSet][google.spanner.v1.ResultSet] contain the number of rows
 modified by the statement.

 Only the first [ResultSet][google.spanner.v1.ResultSet] in the response
 contains valid [ResultSetMetadata][google.spanner.v1.ResultSetMetadata].
      repeated .google.spanner.v1.ResultSet result_sets = 1;
      Specified by:
      getResultSets in interface ExecuteBatchDmlResponseOrBuilder

    • getResultSetsOrBuilder

      public ResultSetOrBuilder getResultSetsOrBuilder(int index)
       One [ResultSet][google.spanner.v1.ResultSet] for each statement in the
 request that ran successfully, in the same order as the statements in the
 request. Each [ResultSet][google.spanner.v1.ResultSet] does not contain any
 rows. The [ResultSetStats][google.spanner.v1.ResultSetStats] in each
 [ResultSet][google.spanner.v1.ResultSet] contain the number of rows
 modified by the statement.

 Only the first [ResultSet][google.spanner.v1.ResultSet] in the response
 contains valid [ResultSetMetadata][google.spanner.v1.ResultSetMetadata].
      repeated .google.spanner.v1.ResultSet result_sets = 1;
      Specified by:
      getResultSetsOrBuilder in interface ExecuteBatchDmlResponseOrBuilder

    • hasStatus

      public boolean hasStatus()
       If all DML statements are executed successfully, the status is `OK`.
 Otherwise, the error status of the first failed statement.
      .google.rpc.Status status = 2;
      Specified by:
      hasStatus in interface ExecuteBatchDmlResponseOrBuilder
      Returns:
      Whether the status field is set.

    • getStatus

      public Status getStatus()
       If all DML statements are executed successfully, the status is `OK`.
 Otherwise, the error status of the first failed statement.
      .google.rpc.Status status = 2;
      Specified by:
      getStatus in interface ExecuteBatchDmlResponseOrBuilder
      Returns:
      The status.

    • getStatusOrBuilder

      public StatusOrBuilder getStatusOrBuilder()
       If all DML statements are executed successfully, the status is `OK`.
 Otherwise, the error status of the first failed statement.
      .google.rpc.Status status = 2;
      Specified by:
      getStatusOrBuilder in interface ExecuteBatchDmlResponseOrBuilder

    • 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 should be passed to the
 [Commit][google.spanner.v1.Spanner.Commit] request for this transaction.
      .google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasPrecommitToken in interface ExecuteBatchDmlResponseOrBuilder
      Returns:
      Whether the precommitToken field is set.

    • 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 should be passed to the
 [Commit][google.spanner.v1.Spanner.Commit] request for this transaction.
      .google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPrecommitToken in interface ExecuteBatchDmlResponseOrBuilder
      Returns:
      The precommitToken.

    • 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 should be passed to the
 [Commit][google.spanner.v1.Spanner.Commit] request for this transaction.
      .google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPrecommitTokenOrBuilder in interface ExecuteBatchDmlResponseOrBuilder

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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 ExecuteBatchDmlResponse parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ExecuteBatchDmlResponse.Builder newBuilder()

    • newBuilder

      public static ExecuteBatchDmlResponse.Builder newBuilder(ExecuteBatchDmlResponse prototype)

    • toBuilder

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

    • newBuilderForType

      protected ExecuteBatchDmlResponse.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static ExecuteBatchDmlResponse getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<ExecuteBatchDmlResponse> 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.GeneratedMessage

    • getDefaultInstanceForType

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