Package com.google.spanner.v1

Class TransactionOptions

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.spanner.v1.TransactionOptions
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, TransactionOptionsOrBuilder, Serializable
public final class TransactionOptions extends com.google.protobuf.GeneratedMessageV3 implements TransactionOptionsOrBuilder
 Options to use for transactions.
Protobuf type google.spanner.v1.TransactionOptions
See Also:

  • Field Details

    • READ_WRITE_FIELD_NUMBER

      public static final int READ_WRITE_FIELD_NUMBER
      See Also:

    • PARTITIONED_DML_FIELD_NUMBER

      public static final int PARTITIONED_DML_FIELD_NUMBER
      See Also:

    • READ_ONLY_FIELD_NUMBER

      public static final int READ_ONLY_FIELD_NUMBER
      See Also:

    • EXCLUDE_TXN_FROM_CHANGE_STREAMS_FIELD_NUMBER

      public static final int EXCLUDE_TXN_FROM_CHANGE_STREAMS_FIELD_NUMBER
      See Also:

    • ISOLATION_LEVEL_FIELD_NUMBER

      public static final int ISOLATION_LEVEL_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getModeCase

      public TransactionOptions.ModeCase getModeCase()
      Specified by:
      getModeCase in interface TransactionOptionsOrBuilder

    • 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;
      Specified by:
      hasReadWrite in interface TransactionOptionsOrBuilder
      Returns:
      Whether the readWrite field is set.

    • 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;
      Specified by:
      getReadWrite in interface TransactionOptionsOrBuilder
      Returns:
      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;
      Specified by:
      getReadWriteOrBuilder in interface TransactionOptionsOrBuilder

    • 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;
      Specified by:
      hasPartitionedDml in interface TransactionOptionsOrBuilder
      Returns:
      Whether the partitionedDml field is set.

    • 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;
      Specified by:
      getPartitionedDml in interface TransactionOptionsOrBuilder
      Returns:
      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;
      Specified by:
      getPartitionedDmlOrBuilder in interface TransactionOptionsOrBuilder

    • 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;
      Specified by:
      hasReadOnly in interface TransactionOptionsOrBuilder
      Returns:
      Whether the readOnly field is set.

    • 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;
      Specified by:
      getReadOnly in interface TransactionOptionsOrBuilder
      Returns:
      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;
      Specified by:
      getReadOnlyOrBuilder in interface TransactionOptionsOrBuilder

    • 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;
      Specified by:
      getExcludeTxnFromChangeStreams in interface TransactionOptionsOrBuilder
      Returns:
      The excludeTxnFromChangeStreams.

    • getIsolationLevelValue

      public int getIsolationLevelValue()
       Isolation level for the transaction.
      .google.spanner.v1.TransactionOptions.IsolationLevel isolation_level = 6;
      Specified by:
      getIsolationLevelValue in interface TransactionOptionsOrBuilder
      Returns:
      The enum numeric value on the wire for isolationLevel.

    • getIsolationLevel

      public TransactionOptions.IsolationLevel getIsolationLevel()
       Isolation level for the transaction.
      .google.spanner.v1.TransactionOptions.IsolationLevel isolation_level = 6;
      Specified by:
      getIsolationLevel in interface TransactionOptionsOrBuilder
      Returns:
      The isolationLevel.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static TransactionOptions parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransactionOptions parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransactionOptions parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransactionOptions parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransactionOptions parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransactionOptions parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransactionOptions parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TransactionOptions parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TransactionOptions parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TransactionOptions parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TransactionOptions parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TransactionOptions parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public TransactionOptions.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static TransactionOptions.Builder newBuilder()

    • newBuilder

      public static TransactionOptions.Builder newBuilder(TransactionOptions prototype)

    • toBuilder

      public TransactionOptions.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected TransactionOptions.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static TransactionOptions getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<TransactionOptions> parser()

    • getParserForType

      public com.google.protobuf.Parser<TransactionOptions> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public TransactionOptions getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder