Interface TransactionOptionsOrBuilder (6.82.0)

public interface TransactionOptionsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getExcludeTxnFromChangeStreams()

public abstract boolean getExcludeTxnFromChangeStreams()

When exclude_txn_from_change_streams is set to true:

  • Mutations from this transaction will not be recorded in change streams with DDL option allow_txn_exclusion=true that are tracking columns modified by these transactions.
  • Mutations from this transaction will be recorded in change streams with DDL option allow_txn_exclusion=false or not set that are tracking columns modified by these transactions.

    When exclude_txn_from_change_streams is set to false or not set, mutations from this transaction will be recorded in all change streams that are tracking columns modified by these transactions. exclude_txn_from_change_streams may only be specified for read-write or partitioned-dml transactions, otherwise the API will return an INVALID_ARGUMENT error.

bool exclude_txn_from_change_streams = 5;

Returns
Type Description
boolean

The excludeTxnFromChangeStreams.

getModeCase()

public abstract TransactionOptions.ModeCase getModeCase()
Returns
Type Description
TransactionOptions.ModeCase

getPartitionedDml()

public abstract 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 abstract 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 abstract TransactionOptions.ReadOnly getReadOnly()

Transaction will 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 abstract TransactionOptions.ReadOnlyOrBuilder getReadOnlyOrBuilder()

Transaction will 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 abstract 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 abstract 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

hasPartitionedDml()

public abstract 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 abstract boolean hasReadOnly()

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