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
Fields
EXACT_STALENESS_FIELD_NUMBER
public static final int EXACT_STALENESS_FIELD_NUMBER
Field Value
MAX_STALENESS_FIELD_NUMBER
public static final int MAX_STALENESS_FIELD_NUMBER
Field Value
MIN_READ_TIMESTAMP_FIELD_NUMBER
public static final int MIN_READ_TIMESTAMP_FIELD_NUMBER
Field Value
READ_TIMESTAMP_FIELD_NUMBER
public static final int READ_TIMESTAMP_FIELD_NUMBER
Field Value
RETURN_READ_TIMESTAMP_FIELD_NUMBER
public static final int RETURN_READ_TIMESTAMP_FIELD_NUMBER
Field Value
STRONG_FIELD_NUMBER
public static final int STRONG_FIELD_NUMBER
Field Value
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstance()
public static TransactionOptions.ReadOnly getDefaultInstance()
Returns
getDefaultInstanceForType()
public TransactionOptions.ReadOnly getDefaultInstanceForType()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
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;
| Type | Description |
| 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;
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;
| Type | Description |
| 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;
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;
| Type | Description |
| 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;
getParserForType()
public Parser<TransactionOptions.ReadOnly> getParserForType()
Returns
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;
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;
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;
| Type | Description |
| boolean | The returnReadTimestamp.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getStrong()
public boolean getStrong()
Read at a timestamp where all previously committed transactions
are visible.
bool strong = 1;
getTimestampBoundCase()
public TransactionOptions.ReadOnly.TimestampBoundCase getTimestampBoundCase()
Returns
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
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;
| Type | Description |
| 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;
| Type | Description |
| 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;
| Type | Description |
| 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;
| Type | Description |
| 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;
| Type | Description |
| boolean | Whether the strong field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilder()
public static TransactionOptions.ReadOnly.Builder newBuilder()
Returns
newBuilder(TransactionOptions.ReadOnly prototype)
public static TransactionOptions.ReadOnly.Builder newBuilder(TransactionOptions.ReadOnly prototype)
Parameter
Returns
newBuilderForType()
public TransactionOptions.ReadOnly.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected TransactionOptions.ReadOnly.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static TransactionOptions.ReadOnly parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static TransactionOptions.ReadOnly parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static TransactionOptions.ReadOnly parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TransactionOptions.ReadOnly parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static TransactionOptions.ReadOnly parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TransactionOptions.ReadOnly parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static TransactionOptions.ReadOnly parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static TransactionOptions.ReadOnly parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static TransactionOptions.ReadOnly parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static TransactionOptions.ReadOnly parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static TransactionOptions.ReadOnly parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static TransactionOptions.ReadOnly parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<TransactionOptions.ReadOnly> parser()
Returns
toBuilder()
public TransactionOptions.ReadOnly.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
