Class TransactionOptions (6.102.0)

public final class TransactionOptions extends GeneratedMessageV3 implements TransactionOptionsOrBuilder

Options to use for transactions.

Protobuf type google.spanner.v1.TransactionOptions

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > TransactionOptions

Implements

TransactionOptionsOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

EXCLUDE_TXN_FROM_CHANGE_STREAMS_FIELD_NUMBER

public static final int EXCLUDE_TXN_FROM_CHANGE_STREAMS_FIELD_NUMBER

Field Value
Type	Description
int

ISOLATION_LEVEL_FIELD_NUMBER

public static final int ISOLATION_LEVEL_FIELD_NUMBER

Field Value
Type	Description
int

PARTITIONED_DML_FIELD_NUMBER

public static final int PARTITIONED_DML_FIELD_NUMBER

Field Value
Type	Description
int

READ_ONLY_FIELD_NUMBER

public static final int READ_ONLY_FIELD_NUMBER

Field Value
Type	Description
int

READ_WRITE_FIELD_NUMBER

public static final int READ_WRITE_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static TransactionOptions getDefaultInstance()

Returns
Type	Description
TransactionOptions

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static TransactionOptions.Builder newBuilder()

Returns
Type	Description
TransactionOptions.Builder

newBuilder(TransactionOptions prototype)

public static TransactionOptions.Builder newBuilder(TransactionOptions prototype)

Parameter
Name	Description
prototype	TransactionOptions

Returns
Type	Description
TransactionOptions.Builder

parseDelimitedFrom(InputStream input)

public static TransactionOptions parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
TransactionOptions

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransactionOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TransactionOptions

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static TransactionOptions parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
TransactionOptions

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TransactionOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TransactionOptions

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TransactionOptions parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
TransactionOptions

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TransactionOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TransactionOptions

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TransactionOptions parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
TransactionOptions

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TransactionOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TransactionOptions

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static TransactionOptions parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
TransactionOptions

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransactionOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TransactionOptions

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static TransactionOptions parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
TransactionOptions

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TransactionOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TransactionOptions

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<TransactionOptions> parser()

Returns
Type	Description
Parser<TransactionOptions>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public TransactionOptions getDefaultInstanceForType()

Returns
Type	Description
TransactionOptions

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.

bool exclude_txn_from_change_streams = 5;

Returns
Type	Description
boolean	The excludeTxnFromChangeStreams.

getIsolationLevel()

public TransactionOptions.IsolationLevel getIsolationLevel()

Isolation level for the transaction.

.google.spanner.v1.TransactionOptions.IsolationLevel isolation_level = 6;

Returns
Type	Description
TransactionOptions.IsolationLevel	The isolationLevel.

getIsolationLevelValue()

public int getIsolationLevelValue()

Isolation level for the transaction.

.google.spanner.v1.TransactionOptions.IsolationLevel isolation_level = 6;

Returns
Type	Description
int	The enum numeric value on the wire for isolationLevel.

getModeCase()

public TransactionOptions.ModeCase getModeCase()

Returns
Type	Description
TransactionOptions.ModeCase

getParserForType()

public Parser<TransactionOptions> getParserForType()

Returns
Type	Description
Parser<TransactionOptions>

Overrides

GeneratedMessageV3.getParserForType()

getPartitionedDml()

public TransactionOptions.PartitionedDml getPartitionedDml()

Partitioned DML transaction.

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

.google.spanner.v1.TransactionOptions.PartitionedDml partitioned_dml = 3;

Returns
Type	Description
TransactionOptions.PartitionedDml	The partitionedDml.

getPartitionedDmlOrBuilder()

public TransactionOptions.PartitionedDmlOrBuilder getPartitionedDmlOrBuilder()

Partitioned DML transaction.

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

.google.spanner.v1.TransactionOptions.PartitionedDml partitioned_dml = 3;

Returns
Type	Description
TransactionOptions.PartitionedDmlOrBuilder

getReadOnly()

public TransactionOptions.ReadOnly getReadOnly()

Transaction does not write.

Authorization to begin a read-only transaction requires spanner.databases.beginReadOnlyTransaction permission on the session resource.

.google.spanner.v1.TransactionOptions.ReadOnly read_only = 2;

Returns
Type	Description
TransactionOptions.ReadOnly	The readOnly.

getReadOnlyOrBuilder()

public TransactionOptions.ReadOnlyOrBuilder getReadOnlyOrBuilder()

Transaction does not write.

Authorization to begin a read-only transaction requires spanner.databases.beginReadOnlyTransaction permission on the session resource.

.google.spanner.v1.TransactionOptions.ReadOnly read_only = 2;

Returns
Type	Description
TransactionOptions.ReadOnlyOrBuilder

getReadWrite()

public TransactionOptions.ReadWrite getReadWrite()

Transaction may write.

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

.google.spanner.v1.TransactionOptions.ReadWrite read_write = 1;

Returns
Type	Description
TransactionOptions.ReadWrite	The readWrite.

getReadWriteOrBuilder()

public TransactionOptions.ReadWriteOrBuilder getReadWriteOrBuilder()

Transaction may write.

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

.google.spanner.v1.TransactionOptions.ReadWrite read_write = 1;

Returns
Type	Description
TransactionOptions.ReadWriteOrBuilder

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

hasPartitionedDml()

public boolean hasPartitionedDml()

Partitioned DML transaction.

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

.google.spanner.v1.TransactionOptions.PartitionedDml partitioned_dml = 3;

Returns
Type	Description
boolean	Whether the partitionedDml field is set.

hasReadOnly()

public boolean hasReadOnly()

Transaction does not write.

Authorization to begin a read-only transaction requires spanner.databases.beginReadOnlyTransaction permission on the session resource.

.google.spanner.v1.TransactionOptions.ReadOnly read_only = 2;

Returns
Type	Description
boolean	Whether the readOnly field is set.

hasReadWrite()

public boolean hasReadWrite()

Transaction may write.

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

.google.spanner.v1.TransactionOptions.ReadWrite read_write = 1;

Returns
Type	Description
boolean	Whether the readWrite field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public TransactionOptions.Builder newBuilderForType()

Returns
Type	Description
TransactionOptions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TransactionOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
TransactionOptions.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public TransactionOptions.Builder toBuilder()

Returns
Type	Description
TransactionOptions.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException