Interface TransactionOptions.ReadOnlyOrBuilder (6.69.0)

public static interface TransactionOptions.ReadOnlyOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getExactStaleness()

public abstract 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
Type Description
Duration

The exactStaleness.

getExactStalenessOrBuilder()

public abstract 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;

Returns
Type Description
DurationOrBuilder

getMaxStaleness()

public abstract 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
Type Description
Duration

The maxStaleness.

getMaxStalenessOrBuilder()

public abstract 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;

Returns
Type Description
DurationOrBuilder

getMinReadTimestamp()

public abstract 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
Type Description
Timestamp

The minReadTimestamp.

getMinReadTimestampOrBuilder()

public abstract 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;

Returns
Type Description
TimestampOrBuilder

getReadTimestamp()

public abstract 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
Type Description
Timestamp

The readTimestamp.

getReadTimestampOrBuilder()

public abstract 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;

Returns
Type Description
TimestampOrBuilder

getReturnReadTimestamp()

public abstract boolean getReturnReadTimestamp()

If true, the Cloud Spanner-selected read timestamp is included in the Transaction message that describes the transaction.

bool return_read_timestamp = 6;

Returns
Type Description
boolean

The returnReadTimestamp.

getStrong()

public abstract boolean getStrong()

Read at a timestamp where all previously committed transactions are visible.

bool strong = 1;

Returns
Type Description
boolean

The strong.

getTimestampBoundCase()

public abstract TransactionOptions.ReadOnly.TimestampBoundCase getTimestampBoundCase()
Returns
Type Description
TransactionOptions.ReadOnly.TimestampBoundCase

hasExactStaleness()

public abstract 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
Type Description
boolean

Whether the exactStaleness field is set.

hasMaxStaleness()

public abstract 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
Type Description
boolean

Whether the maxStaleness field is set.

hasMinReadTimestamp()

public abstract 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
Type Description
boolean

Whether the minReadTimestamp field is set.

hasReadTimestamp()

public abstract 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
Type Description
boolean

Whether the readTimestamp field is set.

hasStrong()

public abstract boolean hasStrong()

Read at a timestamp where all previously committed transactions are visible.

bool strong = 1;

Returns
Type Description
boolean

Whether the strong field is set.