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

Class MultiplexedSessionPrecommitToken

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

When a read-write transaction is executed on a multiplexed session, this precommit token is sent back to the client as a part of the Transaction message in the BeginTransaction response and also as a part of the ResultSet and PartialResultSet responses.

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

Method Summary

Modifier and Type	Method and Description
MultiplexedSessionPrecommitToken	clone()
byte[]	decodePrecommitToken() Opaque precommit token.
MultiplexedSessionPrecommitToken	encodePrecommitToken(byte[] precommitToken) Opaque precommit token.
String	getPrecommitToken() Opaque precommit token.
Integer	getSeqNum() An incrementing seq number is generated on every precommit token that is returned.
MultiplexedSessionPrecommitToken	set(String fieldName, Object value)
MultiplexedSessionPrecommitToken	setPrecommitToken(String precommitToken) Opaque precommit token.
MultiplexedSessionPrecommitToken	setSeqNum(Integer seqNum) An incrementing seq number is generated on every precommit token that is returned.

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

MultiplexedSessionPrecommitToken

public MultiplexedSessionPrecommitToken()

Method Detail

getPrecommitToken

public String getPrecommitToken()

Opaque precommit token.

Returns:

value or null for none

See Also:

decodePrecommitToken()

decodePrecommitToken

public byte[] decodePrecommitToken()

Opaque precommit token.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getPrecommitToken()

setPrecommitToken

public MultiplexedSessionPrecommitToken setPrecommitToken(String precommitToken)

Opaque precommit token.

Parameters:

precommitToken - precommitToken or null for none

See Also:

#encodePrecommitToken()

encodePrecommitToken

public MultiplexedSessionPrecommitToken encodePrecommitToken(byte[] precommitToken)

Opaque precommit token.

Since:

1.14

See Also:

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

getSeqNum

public Integer getSeqNum()

An incrementing seq number is generated on every precommit token that is returned. Clients should remember the precommit token with the highest sequence number from the current transaction attempt.

Returns:

value or null for none

setSeqNum

public MultiplexedSessionPrecommitToken setSeqNum(Integer seqNum)

An incrementing seq number is generated on every precommit token that is returned. Clients should remember the precommit token with the highest sequence number from the current transaction attempt.

Parameters:

seqNum - seqNum or null for none

set

public MultiplexedSessionPrecommitToken set(String fieldName,
                                            Object value)

Overrides:

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

clone

public MultiplexedSessionPrecommitToken clone()

Overrides:

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