Class TransactionOptions.ReadOnly (6.25.1)

public static final class TransactionOptions.ReadOnly extends GeneratedMessageV3 implements TransactionOptions.ReadOnlyOrBuilder

Message type to initiate a read-only transaction.

Protobuf type google.spanner.v1.TransactionOptions.ReadOnly

Static Fields

EXACT_STALENESS_FIELD_NUMBER

public static final int EXACT_STALENESS_FIELD_NUMBER
Field Value
TypeDescription
int

MAX_STALENESS_FIELD_NUMBER

public static final int MAX_STALENESS_FIELD_NUMBER
Field Value
TypeDescription
int

MIN_READ_TIMESTAMP_FIELD_NUMBER

public static final int MIN_READ_TIMESTAMP_FIELD_NUMBER
Field Value
TypeDescription
int

READ_TIMESTAMP_FIELD_NUMBER

public static final int READ_TIMESTAMP_FIELD_NUMBER
Field Value
TypeDescription
int

RETURN_READ_TIMESTAMP_FIELD_NUMBER

public static final int RETURN_READ_TIMESTAMP_FIELD_NUMBER
Field Value
TypeDescription
int

STRONG_FIELD_NUMBER

public static final int STRONG_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static TransactionOptions.ReadOnly getDefaultInstance()
Returns
TypeDescription
TransactionOptions.ReadOnly

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static TransactionOptions.ReadOnly.Builder newBuilder()
Returns
TypeDescription
TransactionOptions.ReadOnly.Builder

newBuilder(TransactionOptions.ReadOnly prototype)

public static TransactionOptions.ReadOnly.Builder newBuilder(TransactionOptions.ReadOnly prototype)
Parameter
NameDescription
prototypeTransactionOptions.ReadOnly
Returns
TypeDescription
TransactionOptions.ReadOnly.Builder

parseDelimitedFrom(InputStream input)

public static TransactionOptions.ReadOnly parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TransactionOptions.ReadOnly
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransactionOptions.ReadOnly parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransactionOptions.ReadOnly
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static TransactionOptions.ReadOnly parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
TransactionOptions.ReadOnly
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TransactionOptions.ReadOnly parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransactionOptions.ReadOnly
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TransactionOptions.ReadOnly parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
TransactionOptions.ReadOnly
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TransactionOptions.ReadOnly parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransactionOptions.ReadOnly
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TransactionOptions.ReadOnly parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
TransactionOptions.ReadOnly
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TransactionOptions.ReadOnly parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransactionOptions.ReadOnly
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static TransactionOptions.ReadOnly parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TransactionOptions.ReadOnly
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransactionOptions.ReadOnly parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransactionOptions.ReadOnly
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static TransactionOptions.ReadOnly parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
TransactionOptions.ReadOnly
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TransactionOptions.ReadOnly parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransactionOptions.ReadOnly
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<TransactionOptions.ReadOnly> parser()
Returns
TypeDescription
Parser<ReadOnly>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public TransactionOptions.ReadOnly getDefaultInstanceForType()
Returns
TypeDescription
TransactionOptions.ReadOnly

getExactStaleness()

public 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
TypeDescription
Duration

The exactStaleness.

getExactStalenessOrBuilder()

public 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
TypeDescription
DurationOrBuilder

getMaxStaleness()

public 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
TypeDescription
Duration

The maxStaleness.

getMaxStalenessOrBuilder()

public 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
TypeDescription
DurationOrBuilder

getMinReadTimestamp()

public 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
TypeDescription
Timestamp

The minReadTimestamp.

getMinReadTimestampOrBuilder()

public 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
TypeDescription
TimestampOrBuilder

getParserForType()

public Parser<TransactionOptions.ReadOnly> getParserForType()
Returns
TypeDescription
Parser<ReadOnly>
Overrides

getReadTimestamp()

public 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
TypeDescription
Timestamp

The readTimestamp.

getReadTimestampOrBuilder()

public 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
TypeDescription
TimestampOrBuilder

getReturnReadTimestamp()

public 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
TypeDescription
boolean

The returnReadTimestamp.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getStrong()

public boolean getStrong()

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

bool strong = 1;

Returns
TypeDescription
boolean

The strong.

getTimestampBoundCase()

public TransactionOptions.ReadOnly.TimestampBoundCase getTimestampBoundCase()
Returns
TypeDescription
TransactionOptions.ReadOnly.TimestampBoundCase

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasExactStaleness()

public 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
TypeDescription
boolean

Whether the exactStaleness field is set.

hasMaxStaleness()

public 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
TypeDescription
boolean

Whether the maxStaleness field is set.

hasMinReadTimestamp()

public 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
TypeDescription
boolean

Whether the minReadTimestamp field is set.

hasReadTimestamp()

public 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
TypeDescription
boolean

Whether the readTimestamp field is set.

hasStrong()

public boolean hasStrong()

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

bool strong = 1;

Returns
TypeDescription
boolean

Whether the strong field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public TransactionOptions.ReadOnly.Builder newBuilderForType()
Returns
TypeDescription
TransactionOptions.ReadOnly.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TransactionOptions.ReadOnly.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
TransactionOptions.ReadOnly.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public TransactionOptions.ReadOnly.Builder toBuilder()
Returns
TypeDescription
TransactionOptions.ReadOnly.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException