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

Class TransactionOptions

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Options to use for transactions.

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

Method Summary

Modifier and Type	Method and Description
TransactionOptions	clone()
Boolean	getExcludeTxnFromChangeStreams() When `exclude_txn_from_change_streams` is set to `true`, it prevents read or write transactions from being tracked in change streams.
String	getIsolationLevel() Isolation level for the transaction.
PartitionedDml	getPartitionedDml() Partitioned DML transaction.
ReadOnly	getReadOnly() Transaction does not write.
ReadWrite	getReadWrite() Transaction may write.
TransactionOptions	set(String fieldName, Object value)
TransactionOptions	setExcludeTxnFromChangeStreams(Boolean excludeTxnFromChangeStreams) When `exclude_txn_from_change_streams` is set to `true`, it prevents read or write transactions from being tracked in change streams.
TransactionOptions	setIsolationLevel(String isolationLevel) Isolation level for the transaction.
TransactionOptions	setPartitionedDml(PartitionedDml partitionedDml) Partitioned DML transaction.
TransactionOptions	setReadOnly(ReadOnly readOnly) Transaction does not write.
TransactionOptions	setReadWrite(ReadWrite readWrite) Transaction may write.

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

TransactionOptions

public TransactionOptions()

Method Detail

getExcludeTxnFromChangeStreams

public Boolean getExcludeTxnFromChangeStreams()

When `exclude_txn_from_change_streams` is set to `true`, it prevents read or write transactions from being tracked in change streams. * If the DDL option `allow_txn_exclusion` is set to `true`, then the updates made within this transaction aren't recorded in the change stream. * If you don't set the DDL option `allow_txn_exclusion` or if it's set to `false`, then the updates made within this transaction are recorded in the change stream. When `exclude_txn_from_change_streams` is set to `false` or not set, modifications from this transaction are recorded in all change streams that are tracking columns modified by these transactions. The `exclude_txn_from_change_streams` option can only be specified for read-write or partitioned DML transactions, otherwise the API returns an `INVALID_ARGUMENT` error.

Returns:

value or null for none

setExcludeTxnFromChangeStreams

public TransactionOptions setExcludeTxnFromChangeStreams(Boolean excludeTxnFromChangeStreams)

When `exclude_txn_from_change_streams` is set to `true`, it prevents read or write transactions from being tracked in change streams. * If the DDL option `allow_txn_exclusion` is set to `true`, then the updates made within this transaction aren't recorded in the change stream. * If you don't set the DDL option `allow_txn_exclusion` or if it's set to `false`, then the updates made within this transaction are recorded in the change stream. When `exclude_txn_from_change_streams` is set to `false` or not set, modifications from this transaction are recorded in all change streams that are tracking columns modified by these transactions. The `exclude_txn_from_change_streams` option can only be specified for read-write or partitioned DML transactions, otherwise the API returns an `INVALID_ARGUMENT` error.

Parameters:

excludeTxnFromChangeStreams - excludeTxnFromChangeStreams or null for none

getIsolationLevel

public String getIsolationLevel()

Isolation level for the transaction.

Returns:

value or null for none

setIsolationLevel

public TransactionOptions setIsolationLevel(String isolationLevel)

Isolation level for the transaction.

Parameters:

isolationLevel - isolationLevel or null for none

getPartitionedDml

public PartitionedDml getPartitionedDml()

Partitioned DML transaction. Authorization to begin a Partitioned DML transaction requires `spanner.databases.beginPartitionedDmlTransaction` permission on the `session` resource.

Returns:

value or null for none

setPartitionedDml

public TransactionOptions setPartitionedDml(PartitionedDml partitionedDml)

Partitioned DML transaction. Authorization to begin a Partitioned DML transaction requires `spanner.databases.beginPartitionedDmlTransaction` permission on the `session` resource.

Parameters:

partitionedDml - partitionedDml or null for none

getReadOnly

public ReadOnly getReadOnly()

Transaction does not write. Authorization to begin a read-only transaction requires `spanner.databases.beginReadOnlyTransaction` permission on the `session` resource.

Returns:

value or null for none

setReadOnly

public TransactionOptions setReadOnly(ReadOnly readOnly)

Transaction does not write. Authorization to begin a read-only transaction requires `spanner.databases.beginReadOnlyTransaction` permission on the `session` resource.

Parameters:

readOnly - readOnly or null for none

getReadWrite

public ReadWrite getReadWrite()

Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource.

Returns:

value or null for none

setReadWrite

public TransactionOptions setReadWrite(ReadWrite readWrite)

Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource.

Parameters:

readWrite - readWrite or null for none

set

public TransactionOptions set(String fieldName,
                              Object value)

Overrides:

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

clone

public TransactionOptions clone()

Overrides:

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