Interface ExecuteBatchDmlRequestOrBuilder (6.83.0)

public interface ExecuteBatchDmlRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getLastStatements()

public abstract boolean getLastStatements()

Optional. If set to true, this request marks the end of the transaction. The transaction should be committed or aborted after these statements execute, and attempts to execute any other requests against this transaction (including reads and queries) will be rejected.

Setting this option may cause some error reporting to be deferred until commit time (e.g. validation of unique constraints). Given this, successful execution of statements should not be assumed until a subsequent Commit call completes successfully.

bool last_statements = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The lastStatements.

getRequestOptions()

public abstract RequestOptions getRequestOptions()

Common options for this request.

.google.spanner.v1.RequestOptions request_options = 5;

Returns
Type Description
RequestOptions

The requestOptions.

getRequestOptionsOrBuilder()

public abstract RequestOptionsOrBuilder getRequestOptionsOrBuilder()

Common options for this request.

.google.spanner.v1.RequestOptions request_options = 5;

Returns
Type Description
RequestOptionsOrBuilder

getSeqno()

public abstract 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];

Returns
Type Description
long

The seqno.

getSession()

public abstract 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) = { ... }

Returns
Type Description
String

The session.

getSessionBytes()

public abstract 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) = { ... }

Returns
Type Description
ByteString

The bytes for session.

getStatements(int index)

public abstract 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];

Parameter
Name Description
index int
Returns
Type Description
ExecuteBatchDmlRequest.Statement

getStatementsCount()

public abstract 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];

Returns
Type Description
int

getStatementsList()

public abstract 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];

Returns
Type Description
List<Statement>

getStatementsOrBuilder(int index)

public abstract 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];

Parameter
Name Description
index int
Returns
Type Description
ExecuteBatchDmlRequest.StatementOrBuilder

getStatementsOrBuilderList()

public abstract 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];

Returns
Type Description
List<? extends com.google.spanner.v1.ExecuteBatchDmlRequest.StatementOrBuilder>

getTransaction()

public abstract 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];

Returns
Type Description
TransactionSelector

The transaction.

getTransactionOrBuilder()

public abstract 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];

Returns
Type Description
TransactionSelectorOrBuilder

hasRequestOptions()

public abstract boolean hasRequestOptions()

Common options for this request.

.google.spanner.v1.RequestOptions request_options = 5;

Returns
Type Description
boolean

Whether the requestOptions field is set.

hasTransaction()

public abstract 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];

Returns
Type Description
boolean

Whether the transaction field is set.