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

Class Transaction

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

A transaction.

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

Method Summary

Modifier and Type	Method and Description
Transaction	clone()
byte[]	decodeId() `id` may be used to identify the transaction in subsequent Read, ExecuteSql, Commit, or Rollback calls.
Transaction	encodeId(byte[] id) `id` may be used to identify the transaction in subsequent Read, ExecuteSql, Commit, or Rollback calls.
String	getId() `id` may be used to identify the transaction in subsequent Read, ExecuteSql, Commit, or Rollback calls.
MultiplexedSessionPrecommitToken	getPrecommitToken() A precommit token is included in the response of a BeginTransaction request if the read-write transaction is on a multiplexed session and a mutation_key was specified in the BeginTransaction.
String	getReadTimestamp() For snapshot read-only transactions, the read timestamp chosen for the transaction.
Transaction	set(String fieldName, Object value)
Transaction	setId(String id) `id` may be used to identify the transaction in subsequent Read, ExecuteSql, Commit, or Rollback calls.
Transaction	setPrecommitToken(MultiplexedSessionPrecommitToken precommitToken) A precommit token is included in the response of a BeginTransaction request if the read-write transaction is on a multiplexed session and a mutation_key was specified in the BeginTransaction.
Transaction	setReadTimestamp(String readTimestamp) For snapshot read-only transactions, the read timestamp chosen for the transaction.

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

Transaction

public Transaction()

Method Detail

getId

public String getId()

`id` may be used to identify the transaction in subsequent Read, ExecuteSql, Commit, or Rollback calls. Single-use read-only transactions do not have IDs, because single-use transactions do not support multiple requests.

Returns:

value or null for none

See Also:

decodeId()

decodeId

public byte[] decodeId()

`id` may be used to identify the transaction in subsequent Read, ExecuteSql, Commit, or Rollback calls. Single-use read-only transactions do not have IDs, because single-use transactions do not support multiple requests.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getId()

setId

public Transaction setId(String id)

`id` may be used to identify the transaction in subsequent Read, ExecuteSql, Commit, or Rollback calls. Single-use read-only transactions do not have IDs, because single-use transactions do not support multiple requests.

Parameters:

id - id or null for none

See Also:

#encodeId()

encodeId

public Transaction encodeId(byte[] id)

`id` may be used to identify the transaction in subsequent Read, ExecuteSql, Commit, or Rollback calls. Single-use read-only transactions do not have IDs, because single-use transactions do not support multiple requests.

Since:

1.14

See Also:

The value is encoded Base64 or {@code null} for none.

getPrecommitToken

public MultiplexedSessionPrecommitToken getPrecommitToken()

A precommit token is included in the response of a BeginTransaction request if the read-write transaction is on a multiplexed session and a mutation_key was specified in the BeginTransaction. 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 Transaction setPrecommitToken(MultiplexedSessionPrecommitToken precommitToken)

A precommit token is included in the response of a BeginTransaction request if the read-write transaction is on a multiplexed session and a mutation_key was specified in the BeginTransaction. 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

getReadTimestamp

public String getReadTimestamp()

For snapshot read-only transactions, the read timestamp chosen for the transaction. Not returned by default: see TransactionOptions.ReadOnly.return_read_timestamp. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: `"2014-10-02T15:01:23.045123456Z"`.

Returns:

value or null for none

setReadTimestamp

public Transaction setReadTimestamp(String readTimestamp)

For snapshot read-only transactions, the read timestamp chosen for the transaction. Not returned by default: see TransactionOptions.ReadOnly.return_read_timestamp. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: `"2014-10-02T15:01:23.045123456Z"`.

Parameters:

readTimestamp - readTimestamp or null for none

set

public Transaction set(String fieldName,
                       Object value)

Overrides:

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

clone

public Transaction clone()

Overrides:

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