Package com.google.spanner.v1

Class ExecuteBatchDmlRequest

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ExecuteBatchDmlRequestOrBuilder, Serializable
    public final class ExecuteBatchDmlRequest
extends com.google.protobuf.GeneratedMessageV3
implements ExecuteBatchDmlRequestOrBuilder
     The request for [ExecuteBatchDml][google.spanner.v1.Spanner.ExecuteBatchDml].
    Protobuf type google.spanner.v1.ExecuteBatchDmlRequest
    See Also:
    Serialized Form

    • 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

      • getSession

        public String getSession()
         Required. The session in which the DML statements should be performed.
        string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getSession in interface ExecuteBatchDmlRequestOrBuilder
        Returns:
        The session.

      • getSessionBytes

        public com.google.protobuf.ByteString getSessionBytes()
         Required. The session in which the DML statements should be performed.
        string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getSessionBytes in interface ExecuteBatchDmlRequestOrBuilder
        Returns:
        The bytes for session.

      • hasTransaction

        public boolean hasTransaction()
         Required. The transaction to use. Must be a read-write transaction.

 To protect against replays, single-use transactions are not supported. The
 caller must either supply an existing transaction ID or begin a new
 transaction.
        .google.spanner.v1.TransactionSelector transaction = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasTransaction in interface ExecuteBatchDmlRequestOrBuilder
        Returns:
        Whether the transaction field is set.

      • getTransaction

        public TransactionSelector getTransaction()
         Required. The transaction to use. Must be a read-write transaction.

 To protect against replays, single-use transactions are not supported. The
 caller must either supply an existing transaction ID or begin a new
 transaction.
        .google.spanner.v1.TransactionSelector transaction = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getTransaction in interface ExecuteBatchDmlRequestOrBuilder
        Returns:
        The transaction.

      • getTransactionOrBuilder

        public TransactionSelectorOrBuilder getTransactionOrBuilder()
         Required. The transaction to use. Must be a read-write transaction.

 To protect against replays, single-use transactions are not supported. The
 caller must either supply an existing transaction ID or begin a new
 transaction.
        .google.spanner.v1.TransactionSelector transaction = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getTransactionOrBuilder in interface ExecuteBatchDmlRequestOrBuilder

      • getStatementsList

        public List<ExecuteBatchDmlRequest.Statement> getStatementsList()
         Required. The list of statements to execute in this batch. Statements are executed
 serially, such that the effects of statement `i` are visible to statement
 `i+1`. Each statement must be a DML statement. Execution stops at the
 first failed statement; the remaining statements are not executed.

 Callers must provide at least one statement.
        repeated .google.spanner.v1.ExecuteBatchDmlRequest.Statement statements = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getStatementsList in interface ExecuteBatchDmlRequestOrBuilder

      • getStatementsOrBuilderList

        public List<? extends ExecuteBatchDmlRequest.StatementOrBuilder> getStatementsOrBuilderList()
         Required. The list of statements to execute in this batch. Statements are executed
 serially, such that the effects of statement `i` are visible to statement
 `i+1`. Each statement must be a DML statement. Execution stops at the
 first failed statement; the remaining statements are not executed.

 Callers must provide at least one statement.
        repeated .google.spanner.v1.ExecuteBatchDmlRequest.Statement statements = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getStatementsOrBuilderList in interface ExecuteBatchDmlRequestOrBuilder

      • getStatementsCount

        public int getStatementsCount()
         Required. The list of statements to execute in this batch. Statements are executed
 serially, such that the effects of statement `i` are visible to statement
 `i+1`. Each statement must be a DML statement. Execution stops at the
 first failed statement; the remaining statements are not executed.

 Callers must provide at least one statement.
        repeated .google.spanner.v1.ExecuteBatchDmlRequest.Statement statements = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getStatementsCount in interface ExecuteBatchDmlRequestOrBuilder

      • getStatements

        public ExecuteBatchDmlRequest.Statement getStatements​(int index)
         Required. The list of statements to execute in this batch. Statements are executed
 serially, such that the effects of statement `i` are visible to statement
 `i+1`. Each statement must be a DML statement. Execution stops at the
 first failed statement; the remaining statements are not executed.

 Callers must provide at least one statement.
        repeated .google.spanner.v1.ExecuteBatchDmlRequest.Statement statements = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getStatements in interface ExecuteBatchDmlRequestOrBuilder

      • getStatementsOrBuilder

        public ExecuteBatchDmlRequest.StatementOrBuilder getStatementsOrBuilder​(int index)
         Required. The list of statements to execute in this batch. Statements are executed
 serially, such that the effects of statement `i` are visible to statement
 `i+1`. Each statement must be a DML statement. Execution stops at the
 first failed statement; the remaining statements are not executed.

 Callers must provide at least one statement.
        repeated .google.spanner.v1.ExecuteBatchDmlRequest.Statement statements = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getStatementsOrBuilder in interface ExecuteBatchDmlRequestOrBuilder

      • getSeqno

        public long getSeqno()
         Required. A per-transaction sequence number used to identify this request. This field
 makes each request idempotent such that if the request is received multiple
 times, at most one will succeed.

 The sequence number must be monotonically increasing within the
 transaction. If a request arrives for the first time with an out-of-order
 sequence number, the transaction may be aborted. Replays of previously
 handled requests will yield the same response as the first execution.
        int64 seqno = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getSeqno in interface ExecuteBatchDmlRequestOrBuilder
        Returns:
        The seqno.

      • hasRequestOptions

        public boolean hasRequestOptions()
         Common options for this request.
        .google.spanner.v1.RequestOptions request_options = 5;
        Specified by:
        hasRequestOptions in interface ExecuteBatchDmlRequestOrBuilder
        Returns:
        Whether the requestOptions field is set.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<ExecuteBatchDmlRequest> 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 ExecuteBatchDmlRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder