com.google.api.services.spanner.v1.model

Class ExecuteBatchDmlRequest

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.spanner.v1.model.ExecuteBatchDmlRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class ExecuteBatchDmlRequest
extends com.google.api.client.json.GenericJson

The request for ExecuteBatchDml.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Spanner API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ExecuteBatchDmlRequest()

Method Summary

Modifier and Type	Method and Description
ExecuteBatchDmlRequest	clone()
Boolean	getLastStatements() Optional.
RequestOptions	getRequestOptions() Common options for this request.
Long	getSeqno() Required.
List<Statement>	getStatements() Required.
TransactionSelector	getTransaction() Required.
ExecuteBatchDmlRequest	set(String fieldName, Object value)
ExecuteBatchDmlRequest	setLastStatements(Boolean lastStatements) Optional.
ExecuteBatchDmlRequest	setRequestOptions(RequestOptions requestOptions) Common options for this request.
ExecuteBatchDmlRequest	setSeqno(Long seqno) Required.
ExecuteBatchDmlRequest	setStatements(List<Statement> statements) Required.
ExecuteBatchDmlRequest	setTransaction(TransactionSelector transaction) Required.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

ExecuteBatchDmlRequest

public ExecuteBatchDmlRequest()

Method Detail

getLastStatements

public Boolean getLastStatements()

Optional. If set to `true`, this request marks the end of the transaction. After these statements execute, you must commit or abort the transaction. Attempts to execute any other requests against this transaction (including reads and queries) are rejected. Setting this option might cause some error reporting to be deferred until commit time (for example, validation of unique constraints). Given this, successful execution of statements shouldn't be assumed until a subsequent `Commit` call completes successfully.

Returns:

value or null for none

setLastStatements

public ExecuteBatchDmlRequest setLastStatements(Boolean lastStatements)

Optional. If set to `true`, this request marks the end of the transaction. After these statements execute, you must commit or abort the transaction. Attempts to execute any other requests against this transaction (including reads and queries) are rejected. Setting this option might cause some error reporting to be deferred until commit time (for example, validation of unique constraints). Given this, successful execution of statements shouldn't be assumed until a subsequent `Commit` call completes successfully.

Parameters:

lastStatements - lastStatements or null for none

getRequestOptions

public RequestOptions getRequestOptions()

Common options for this request.

Returns:

value or null for none

setRequestOptions

public ExecuteBatchDmlRequest setRequestOptions(RequestOptions requestOptions)

Common options for this request.

Parameters:

requestOptions - requestOptions or null for none

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 succeeds. 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 might be aborted. Replays of previously handled requests yield the same response as the first execution.

Returns:

value or null for none

setSeqno

public ExecuteBatchDmlRequest setSeqno(Long seqno)

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 succeeds. 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 might be aborted. Replays of previously handled requests yield the same response as the first execution.

Parameters:

seqno - seqno or null for none

getStatements

public List<Statement> getStatements()

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.

Returns:

value or null for none

setStatements

public ExecuteBatchDmlRequest setStatements(List<Statement> statements)

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.

Parameters:

statements - statements or null for none

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.

Returns:

value or null for none

setTransaction

public ExecuteBatchDmlRequest setTransaction(TransactionSelector transaction)

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.

Parameters:

transaction - transaction or null for none

set

public ExecuteBatchDmlRequest set(String fieldName,
                                  Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public ExecuteBatchDmlRequest clone()

Overrides:

clone in class com.google.api.client.json.GenericJson