Class ExecuteBatchDmlResponse

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ExecuteBatchDmlResponseOrBuilder, Serializable

    public final class ExecuteBatchDmlResponse
    extends com.google.protobuf.GeneratedMessageV3
    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:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ExecuteBatchDmlResponse.Builder
      The response for [ExecuteBatchDml][google.spanner.v1.Spanner.ExecuteBatchDml].
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int RESULT_SETS_FIELD_NUMBER  
      static int STATUS_FIELD_NUMBER  
      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields
      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize
      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode
    • Method Detail

      • 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
      • 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 com.google.rpc.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 com.google.rpc.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
      • 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 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
      • newBuilderForType

        public ExecuteBatchDmlResponse.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • 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.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • 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.GeneratedMessageV3
      • getDefaultInstanceForType

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