Package com.google.spanner.v1

Interface TransactionOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Transaction, Transaction.Builder
@Generated public interface TransactionOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    CacheUpdate
    getCacheUpdate()
    Optional.
    CacheUpdateOrBuilder
    getCacheUpdateOrBuilder()
    Optional.
    com.google.protobuf.ByteString
    getId()
    `id` may be used to identify the transaction in subsequent [Read][google.spanner.v1.Spanner.Read], [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql], [Commit][google.spanner.v1.Spanner.Commit], or [Rollback][google.spanner.v1.Spanner.Rollback] calls.
    MultiplexedSessionPrecommitToken
    getPrecommitToken()
    A precommit token is included in the response of a BeginTransaction request if the read-write transaction is on a multiplexed session and a mutation_key was specified in the [BeginTransaction][google.spanner.v1.BeginTransactionRequest].
    MultiplexedSessionPrecommitTokenOrBuilder
    getPrecommitTokenOrBuilder()
    A precommit token is included in the response of a BeginTransaction request if the read-write transaction is on a multiplexed session and a mutation_key was specified in the [BeginTransaction][google.spanner.v1.BeginTransactionRequest].
    com.google.protobuf.Timestamp
    getReadTimestamp()
    For snapshot read-only transactions, the read timestamp chosen for the transaction.
    com.google.protobuf.TimestampOrBuilder
    getReadTimestampOrBuilder()
    For snapshot read-only transactions, the read timestamp chosen for the transaction.
    boolean
    hasCacheUpdate()
    Optional.
    boolean
    hasPrecommitToken()
    A precommit token is included in the response of a BeginTransaction request if the read-write transaction is on a multiplexed session and a mutation_key was specified in the [BeginTransaction][google.spanner.v1.BeginTransactionRequest].
    boolean
    hasReadTimestamp()
    For snapshot read-only transactions, the read timestamp chosen for the transaction.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getId

      com.google.protobuf.ByteString getId()
       `id` may be used to identify the transaction in subsequent
 [Read][google.spanner.v1.Spanner.Read],
 [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql],
 [Commit][google.spanner.v1.Spanner.Commit], or
 [Rollback][google.spanner.v1.Spanner.Rollback] calls.

 Single-use read-only transactions do not have IDs, because
 single-use transactions do not support multiple requests.
      bytes id = 1;
      Returns:
      The id.

    • hasReadTimestamp

      boolean hasReadTimestamp()
       For snapshot read-only transactions, the read timestamp chosen
 for the transaction. Not returned by default: see
 [TransactionOptions.ReadOnly.return_read_timestamp][google.spanner.v1.TransactionOptions.ReadOnly.return_read_timestamp].

 A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds.
 Example: `"2014-10-02T15:01:23.045123456Z"`.
      .google.protobuf.Timestamp read_timestamp = 2;
      Returns:
      Whether the readTimestamp field is set.

    • getReadTimestamp

      com.google.protobuf.Timestamp getReadTimestamp()
       For snapshot read-only transactions, the read timestamp chosen
 for the transaction. Not returned by default: see
 [TransactionOptions.ReadOnly.return_read_timestamp][google.spanner.v1.TransactionOptions.ReadOnly.return_read_timestamp].

 A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds.
 Example: `"2014-10-02T15:01:23.045123456Z"`.
      .google.protobuf.Timestamp read_timestamp = 2;
      Returns:
      The readTimestamp.

    • getReadTimestampOrBuilder

      com.google.protobuf.TimestampOrBuilder getReadTimestampOrBuilder()
       For snapshot read-only transactions, the read timestamp chosen
 for the transaction. Not returned by default: see
 [TransactionOptions.ReadOnly.return_read_timestamp][google.spanner.v1.TransactionOptions.ReadOnly.return_read_timestamp].

 A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds.
 Example: `"2014-10-02T15:01:23.045123456Z"`.
      .google.protobuf.Timestamp read_timestamp = 2;

    • hasPrecommitToken

      boolean hasPrecommitToken()
       A precommit token is included in the response of a BeginTransaction
 request if the read-write transaction is on a multiplexed session and
 a mutation_key was specified in the
 [BeginTransaction][google.spanner.v1.BeginTransactionRequest].
 The precommit token with the highest sequence number from this transaction
 attempt should be passed to the [Commit][google.spanner.v1.Spanner.Commit]
 request for this transaction.
      .google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 3;
      Returns:
      Whether the precommitToken field is set.

    • getPrecommitToken

      MultiplexedSessionPrecommitToken getPrecommitToken()
       A precommit token is included in the response of a BeginTransaction
 request if the read-write transaction is on a multiplexed session and
 a mutation_key was specified in the
 [BeginTransaction][google.spanner.v1.BeginTransactionRequest].
 The precommit token with the highest sequence number from this transaction
 attempt should be passed to the [Commit][google.spanner.v1.Spanner.Commit]
 request for this transaction.
      .google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 3;
      Returns:
      The precommitToken.

    • getPrecommitTokenOrBuilder

      MultiplexedSessionPrecommitTokenOrBuilder getPrecommitTokenOrBuilder()
       A precommit token is included in the response of a BeginTransaction
 request if the read-write transaction is on a multiplexed session and
 a mutation_key was specified in the
 [BeginTransaction][google.spanner.v1.BeginTransactionRequest].
 The precommit token with the highest sequence number from this transaction
 attempt should be passed to the [Commit][google.spanner.v1.Spanner.Commit]
 request for this transaction.
      .google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 3;

    • hasCacheUpdate

      boolean hasCacheUpdate()
       Optional. A cache update expresses a set of changes the client should
 incorporate into its location cache. The client should discard the changes
 if they are older than the data it already has. This data can be obtained
 in response to requests that included a `RoutingHint` field, but may also
 be obtained by explicit location-fetching RPCs which may be added in the
 future.
      .google.spanner.v1.CacheUpdate cache_update = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the cacheUpdate field is set.

    • getCacheUpdate

      CacheUpdate getCacheUpdate()
       Optional. A cache update expresses a set of changes the client should
 incorporate into its location cache. The client should discard the changes
 if they are older than the data it already has. This data can be obtained
 in response to requests that included a `RoutingHint` field, but may also
 be obtained by explicit location-fetching RPCs which may be added in the
 future.
      .google.spanner.v1.CacheUpdate cache_update = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The cacheUpdate.

    • getCacheUpdateOrBuilder

      CacheUpdateOrBuilder getCacheUpdateOrBuilder()
       Optional. A cache update expresses a set of changes the client should
 incorporate into its location cache. The client should discard the changes
 if they are older than the data it already has. This data can be obtained
 in response to requests that included a `RoutingHint` field, but may also
 be obtained by explicit location-fetching RPCs which may be added in the
 future.
      .google.spanner.v1.CacheUpdate cache_update = 5 [(.google.api.field_behavior) = OPTIONAL];