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

Class ExecuteBatchDmlResponse

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.ExecuteBatchDmlResponse

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

The response for ExecuteBatchDml. Contains a list of 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 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 messages, then statement `N+1` in the request failed. Example 1: * Request: 5 DML statements, all executed successfully. * Response: 5 ResultSet messages, with the status `OK`. Example 2: * Request: 5 DML statements. The third statement has a syntax error. * Response: 2 ResultSet messages, and a syntax error (`INVALID_ARGUMENT`) status. The number of ResultSet messages indicates that the third statement failed, and the fourth and fifth statements were not executed.

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
ExecuteBatchDmlResponse()

Method Summary

Modifier and Type	Method and Description
ExecuteBatchDmlResponse	clone()
MultiplexedSessionPrecommitToken	getPrecommitToken() Optional.
List<ResultSet>	getResultSets() One ResultSet for each statement in the request that ran successfully, in the same order as the statements in the request.
Status	getStatus() If all DML statements are executed successfully, the status is `OK`.
ExecuteBatchDmlResponse	set(String fieldName, Object value)
ExecuteBatchDmlResponse	setPrecommitToken(MultiplexedSessionPrecommitToken precommitToken) Optional.
ExecuteBatchDmlResponse	setResultSets(List<ResultSet> resultSets) One ResultSet for each statement in the request that ran successfully, in the same order as the statements in the request.
ExecuteBatchDmlResponse	setStatus(Status status) If all DML statements are executed successfully, the status is `OK`.

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

ExecuteBatchDmlResponse

public ExecuteBatchDmlResponse()

Method Detail

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 request for this transaction.

Returns:

value or null for none

setPrecommitToken

public ExecuteBatchDmlResponse setPrecommitToken(MultiplexedSessionPrecommitToken precommitToken)

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 request for this transaction.

Parameters:

precommitToken - precommitToken or null for none

getResultSets

public List<ResultSet> getResultSets()

One ResultSet for each statement in the request that ran successfully, in the same order as the statements in the request. Each ResultSet does not contain any rows. The ResultSetStats in each ResultSet contain the number of rows modified by the statement. Only the first ResultSet in the response contains valid ResultSetMetadata.

Returns:

value or null for none

setResultSets

public ExecuteBatchDmlResponse setResultSets(List<ResultSet> resultSets)

One ResultSet for each statement in the request that ran successfully, in the same order as the statements in the request. Each ResultSet does not contain any rows. The ResultSetStats in each ResultSet contain the number of rows modified by the statement. Only the first ResultSet in the response contains valid ResultSetMetadata.

Parameters:

resultSets - resultSets or null for none

getStatus

public Status getStatus()

If all DML statements are executed successfully, the status is `OK`. Otherwise, the error status of the first failed statement.

Returns:

value or null for none

setStatus

public ExecuteBatchDmlResponse setStatus(Status status)

If all DML statements are executed successfully, the status is `OK`. Otherwise, the error status of the first failed statement.

Parameters:

status - status or null for none

set

public ExecuteBatchDmlResponse set(String fieldName,
                                   Object value)

Overrides:

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

clone

public ExecuteBatchDmlResponse clone()

Overrides:

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