Class TransactionOptions.ReadOnly.Builder (6.77.0)

public static final class TransactionOptions.ReadOnly.Builder extends GeneratedMessageV3.Builder<TransactionOptions.ReadOnly.Builder> implements TransactionOptions.ReadOnlyOrBuilder

Message type to initiate a read-only transaction.

Protobuf type google.spanner.v1.TransactionOptions.ReadOnly

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TransactionOptions.ReadOnly.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TransactionOptions.ReadOnly.Builder
Overrides

build()

public TransactionOptions.ReadOnly build()
Returns
Type Description
TransactionOptions.ReadOnly

buildPartial()

public TransactionOptions.ReadOnly buildPartial()
Returns
Type Description
TransactionOptions.ReadOnly

clear()

public TransactionOptions.ReadOnly.Builder clear()
Returns
Type Description
TransactionOptions.ReadOnly.Builder
Overrides

clearExactStaleness()

public TransactionOptions.ReadOnly.Builder clearExactStaleness()

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
TransactionOptions.ReadOnly.Builder

clearField(Descriptors.FieldDescriptor field)

public TransactionOptions.ReadOnly.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
TransactionOptions.ReadOnly.Builder
Overrides

clearMaxStaleness()

public TransactionOptions.ReadOnly.Builder clearMaxStaleness()

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
TransactionOptions.ReadOnly.Builder

clearMinReadTimestamp()

public TransactionOptions.ReadOnly.Builder clearMinReadTimestamp()

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
TransactionOptions.ReadOnly.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public TransactionOptions.ReadOnly.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
TransactionOptions.ReadOnly.Builder
Overrides

clearReadTimestamp()

public TransactionOptions.ReadOnly.Builder clearReadTimestamp()

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
TransactionOptions.ReadOnly.Builder

clearReturnReadTimestamp()

public TransactionOptions.ReadOnly.Builder clearReturnReadTimestamp()

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

bool return_read_timestamp = 6;

Retu