Package com.google.spanner.v1

Interface TransactionOptions.ReadOnlyOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
TransactionOptions.ReadOnly, TransactionOptions.ReadOnly.Builder
Enclosing class:
TransactionOptions
public static interface TransactionOptions.ReadOnlyOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.Duration
    getExactStaleness()
    Executes all reads at a timestamp that is `exact_staleness` old.
    com.google.protobuf.DurationOrBuilder
    getExactStalenessOrBuilder()
    Executes all reads at a timestamp that is `exact_staleness` old.
    com.google.protobuf.Duration
    getMaxStaleness()
    Read data at a timestamp >= `NOW - max_staleness` seconds.
    com.google.protobuf.DurationOrBuilder
    getMaxStalenessOrBuilder()
    Read data at a timestamp >= `NOW - max_staleness` seconds.
    com.google.protobuf.Timestamp
    getMinReadTimestamp()
    Executes all reads at a timestamp >= `min_read_timestamp`.
    com.google.protobuf.TimestampOrBuilder
    getMinReadTimestampOrBuilder()
    Executes all reads at a timestamp >= `min_read_timestamp`.
    com.google.protobuf.Timestamp
    getReadTimestamp()
    Executes all reads at the given timestamp.
    com.google.protobuf.TimestampOrBuilder
    getReadTimestampOrBuilder()
    Executes all reads at the given timestamp.
    boolean
    getReturnReadTimestamp()
    If true, the Cloud Spanner-selected read timestamp is included in the [Transaction][google.spanner.v1.Transaction] message that describes the transaction.
    boolean
    getStrong()
    Read at a timestamp where all previously committed transactions are visible.
    TransactionOptions.ReadOnly.TimestampBoundCase
    getTimestampBoundCase()
     
    boolean
    hasExactStaleness()
    Executes all reads at a timestamp that is `exact_staleness` old.
    boolean
    hasMaxStaleness()
    Read data at a timestamp >= `NOW - max_staleness` seconds.
    boolean
    hasMinReadTimestamp()
    Executes all reads at a timestamp >= `min_read_timestamp`.
    boolean
    hasReadTimestamp()
    Executes all reads at the given timestamp.
    boolean
    hasStrong()
    Read at a timestamp where all previously committed transactions are visible.

    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

    • hasStrong

      boolean hasStrong()
       Read at a timestamp where all previously committed transactions
 are visible.
      bool strong = 1;
      Returns:
      Whether the strong field is set.

    • getStrong

      boolean getStrong()
       Read at a timestamp where all previously committed transactions
 are visible.
      bool strong = 1;
      Returns:
      The strong.

    • hasMinReadTimestamp

      boolean hasMinReadTimestamp()
       Executes all reads at a timestamp >= `min_read_timestamp`.

 This is useful for requesting fresher data than some previous
 read, or data that is fresh enough to observe the effects of some
 previously committed transaction whose timestamp is known.

 Note that this option can only be used in single-use transactions.

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

    • getMinReadTimestamp

      com.google.protobuf.Timestamp getMinReadTimestamp()
       Executes all reads at a timestamp >= `min_read_timestamp`.

 This is useful for requesting fresher data than some previous
 read, or data that is fresh enough to observe the effects of some
 previously committed transaction whose timestamp is known.

 Note that this option can only be used in single-use transactions.

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

    • getMinReadTimestampOrBuilder

      com.google.protobuf.TimestampOrBuilder getMinReadTimestampOrBuilder()
       Executes all reads at a timestamp >= `min_read_timestamp`.

 This is useful for requesting fresher data than some previous
 read, or data that is fresh enough to observe the effects of some
 previously committed transaction whose timestamp is known.

 Note that this option can only be used in single-use transactions.

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

    • hasMaxStaleness

      boolean hasMaxStaleness()
       Read data at a timestamp >= `NOW - max_staleness`
 seconds. Guarantees that all writes that have committed more
 than the specified number of seconds ago are visible. Because
 Cloud Spanner chooses the exact timestamp, this mode works even if
 the client's local clock is substantially skewed from Cloud Spanner
 commit timestamps.

 Useful for reading the freshest data available at a nearby
 replica, while bounding the possible staleness if the local
 replica has fallen behind.

 Note that this option can only be used in single-use
 transactions.
      .google.protobuf.Duration max_staleness = 3;
      Returns:
      Whether the maxStaleness field is set.

    • getMaxStaleness

      com.google.protobuf.Duration getMaxStaleness()
       Read data at a timestamp >= `NOW - max_staleness`
 seconds. Guarantees that all writes that have committed more
 than the specified number of seconds ago are visible. Because
 Cloud Spanner chooses the exact timestamp, this mode works even if
 the client's local clock is substantially skewed from Cloud Spanner
 commit timestamps.

 Useful for reading the freshest data available at a nearby
 replica, while bounding the possible staleness if the local
 replica has fallen behind.

 Note that this option can only be used in single-use
 transactions.
      .google.protobuf.Duration max_staleness = 3;
      Returns:
      The maxStaleness.

    • getMaxStalenessOrBuilder

      com.google.protobuf.DurationOrBuilder getMaxStalenessOrBuilder()
       Read data at a timestamp >= `NOW - max_staleness`
 seconds. Guarantees that all writes that have committed more
 than the specified number of seconds ago are visible. Because
 Cloud Spanner chooses the exact timestamp, this mode works even if
 the client's local clock is substantially skewed from Cloud Spanner
 commit timestamps.

 Useful for reading the freshest data available at a nearby
 replica, while bounding the possible staleness if the local
 replica has fallen behind.

 Note that this option can only be used in single-use
 transactions.
      .google.protobuf.Duration max_staleness = 3;

    • hasReadTimestamp

      boolean hasReadTimestamp()
       Executes all reads at the given timestamp. Unlike other modes,
 reads at a specific timestamp are repeatable; the same read at
 the same timestamp always returns the same data. If the
 timestamp is in the future, the read will block until the
 specified timestamp, modulo the read's deadline.

 Useful for large scale consistent reads such as mapreduces, or
 for coordinating many reads against a consistent snapshot of the
 data.

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

    • getReadTimestamp

      com.google.protobuf.Timestamp getReadTimestamp()
       Executes all reads at the given timestamp. Unlike other modes,
 reads at a specific timestamp are repeatable; the same read at
 the same timestamp always returns the same data. If the
 timestamp is in the future, the read will block until the
 specified timestamp, modulo the read's deadline.

 Useful for large scale consistent reads such as mapreduces, or
 for coordinating many reads against a consistent snapshot of the
 data.

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

    • getReadTimestampOrBuilder

      com.google.protobuf.TimestampOrBuilder getReadTimestampOrBuilder()
       Executes all reads at the given timestamp. Unlike other modes,
 reads at a specific timestamp are repeatable; the same read at
 the same timestamp always returns the same data. If the
 timestamp is in the future, the read will block until the
 specified timestamp, modulo the read's deadline.

 Useful for large scale consistent reads such as mapreduces, or
 for coordinating many reads against a consistent snapshot of the
 data.

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

    • hasExactStaleness

      boolean hasExactStaleness()
       Executes all reads at a timestamp that is `exact_staleness`
 old. The timestamp is chosen soon after the read is started.

 Guarantees that all writes that have committed more than the
 specified number of seconds ago are visible. Because Cloud Spanner
 chooses the exact timestamp, this mode works even if the client's
 local clock is substantially skewed from Cloud Spanner commit
 timestamps.

 Useful for reading at nearby replicas without the distributed
 timestamp negotiation overhead of `max_staleness`.
      .google.protobuf.Duration exact_staleness = 5;
      Returns:
      Whether the exactStaleness field is set.

    • getExactStaleness

      com.google.protobuf.Duration getExactStaleness()
       Executes all reads at a timestamp that is `exact_staleness`
 old. The timestamp is chosen soon after the read is started.

 Guarantees that all writes that have committed more than the
 specified number of seconds ago are visible. Because Cloud Spanner
 chooses the exact timestamp, this mode works even if the client's
 local clock is substantially skewed from Cloud Spanner commit
 timestamps.

 Useful for reading at nearby replicas without the distributed
 timestamp negotiation overhead of `max_staleness`.
      .google.protobuf.Duration exact_staleness = 5;
      Returns:
      The exactStaleness.

    • getExactStalenessOrBuilder

      com.google.protobuf.DurationOrBuilder getExactStalenessOrBuilder()
       Executes all reads at a timestamp that is `exact_staleness`
 old. The timestamp is chosen soon after the read is started.

 Guarantees that all writes that have committed more than the
 specified number of seconds ago are visible. Because Cloud Spanner
 chooses the exact timestamp, this mode works even if the client's
 local clock is substantially skewed from Cloud Spanner commit
 timestamps.

 Useful for reading at nearby replicas without the distributed
 timestamp negotiation overhead of `max_staleness`.
      .google.protobuf.Duration exact_staleness = 5;

    • getReturnReadTimestamp

      boolean getReturnReadTimestamp()
       If true, the Cloud Spanner-selected read timestamp is included in
 the [Transaction][google.spanner.v1.Transaction] message that describes
 the transaction.
      bool return_read_timestamp = 6;
      Returns:
      The returnReadTimestamp.

    • getTimestampBoundCase

      TransactionOptions.ReadOnly.TimestampBoundCase getTimestampBoundCase()