com.google.spanner.v1

Class TransactionOptions.ReadOnly

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.spanner.v1.TransactionOptions.ReadOnly

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, TransactionOptions.ReadOnlyOrBuilder, Serializable

Enclosing class:

TransactionOptions

public static final class TransactionOptions.ReadOnly
extends com.google.protobuf.GeneratedMessageV3
implements TransactionOptions.ReadOnlyOrBuilder

 Message type to initiate a read-only transaction.
 

Protobuf type google.spanner.v1.TransactionOptions.ReadOnly

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TransactionOptions.ReadOnly.Builder Message type to initiate a read-only transaction.
static class	TransactionOptions.ReadOnly.TimestampBoundCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	EXACT_STALENESS_FIELD_NUMBER
static int	MAX_STALENESS_FIELD_NUMBER
static int	MIN_READ_TIMESTAMP_FIELD_NUMBER
static int	READ_TIMESTAMP_FIELD_NUMBER
static int	RETURN_READ_TIMESTAMP_FIELD_NUMBER
static int	STRONG_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static TransactionOptions.ReadOnly	getDefaultInstance()
TransactionOptions.ReadOnly	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.Parser<TransactionOptions.ReadOnly>	getParserForType()
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.
int	getSerializedSize()
boolean	getStrong() Read at a timestamp where all previously committed transactions are visible.
TransactionOptions.ReadOnly.TimestampBoundCase	getTimestampBoundCase()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasExactStaleness() Executes all reads at a timestamp that is `exact_staleness` old.
int	hashCode()
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.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static TransactionOptions.ReadOnly.Builder	newBuilder()
static TransactionOptions.ReadOnly.Builder	newBuilder(TransactionOptions.ReadOnly prototype)
TransactionOptions.ReadOnly.Builder	newBuilderForType()
protected TransactionOptions.ReadOnly.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static TransactionOptions.ReadOnly	parseDelimitedFrom(InputStream input)
static TransactionOptions.ReadOnly	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TransactionOptions.ReadOnly	parseFrom(byte[] data)
static TransactionOptions.ReadOnly	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TransactionOptions.ReadOnly	parseFrom(ByteBuffer data)
static TransactionOptions.ReadOnly	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TransactionOptions.ReadOnly	parseFrom(com.google.protobuf.ByteString data)
static TransactionOptions.ReadOnly	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TransactionOptions.ReadOnly	parseFrom(com.google.protobuf.CodedInputStream input)
static TransactionOptions.ReadOnly	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TransactionOptions.ReadOnly	parseFrom(InputStream input)
static TransactionOptions.ReadOnly	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<TransactionOptions.ReadOnly>	parser()
TransactionOptions.ReadOnly.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

STRONG_FIELD_NUMBER

public static final int STRONG_FIELD_NUMBER

See Also:

Constant Field Values

MIN_READ_TIMESTAMP_FIELD_NUMBER

public static final int MIN_READ_TIMESTAMP_FIELD_NUMBER

See Also:

Constant Field Values

MAX_STALENESS_FIELD_NUMBER

public static final int MAX_STALENESS_FIELD_NUMBER

See Also:

Constant Field Values

READ_TIMESTAMP_FIELD_NUMBER

public static final int READ_TIMESTAMP_FIELD_NUMBER

See Also:

Constant Field Values

EXACT_STALENESS_FIELD_NUMBER

public static final int EXACT_STALENESS_FIELD_NUMBER

See Also:

Constant Field Values

RETURN_READ_TIMESTAMP_FIELD_NUMBER

public static final int RETURN_READ_TIMESTAMP_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getTimestampBoundCase

public TransactionOptions.ReadOnly.TimestampBoundCase getTimestampBoundCase()

Specified by:

getTimestampBoundCase in interface TransactionOptions.ReadOnlyOrBuilder

getStrong

public boolean getStrong()

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

bool strong = 1;

Specified by:

getStrong in interface TransactionOptions.ReadOnlyOrBuilder

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;

Specified by:

hasMinReadTimestamp in interface TransactionOptions.ReadOnlyOrBuilder

getMinReadTimestamp

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

Specified by:

getMinReadTimestamp in interface TransactionOptions.ReadOnlyOrBuilder

getMinReadTimestampOrBuilder

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

Specified by:

getMinReadTimestampOrBuilder in interface TransactionOptions.ReadOnlyOrBuilder

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;

Specified by:

hasMaxStaleness in interface TransactionOptions.ReadOnlyOrBuilder

getMaxStaleness

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

Specified by:

getMaxStaleness in interface TransactionOptions.ReadOnlyOrBuilder

getMaxStalenessOrBuilder

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

Specified by:

getMaxStalenessOrBuilder in interface TransactionOptions.ReadOnlyOrBuilder

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;

Specified by:

hasReadTimestamp in interface TransactionOptions.ReadOnlyOrBuilder

getReadTimestamp

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

Specified by:

getReadTimestamp in interface TransactionOptions.ReadOnlyOrBuilder

getReadTimestampOrBuilder

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

Specified by:

getReadTimestampOrBuilder in interface TransactionOptions.ReadOnlyOrBuilder

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;

Specified by:

hasExactStaleness in interface TransactionOptions.ReadOnlyOrBuilder

getExactStaleness

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

Specified by:

getExactStaleness in interface TransactionOptions.ReadOnlyOrBuilder

getExactStalenessOrBuilder

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

Specified by:

getExactStalenessOrBuilder in interface TransactionOptions.ReadOnlyOrBuilder

getReturnReadTimestamp

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

Specified by:

getReturnReadTimestamp in interface TransactionOptions.ReadOnlyOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static TransactionOptions.ReadOnly parseFrom(ByteBuffer data)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TransactionOptions.ReadOnly parseFrom(ByteBuffer data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TransactionOptions.ReadOnly parseFrom(com.google.protobuf.ByteString data)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TransactionOptions.ReadOnly parseFrom(com.google.protobuf.ByteString data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TransactionOptions.ReadOnly parseFrom(byte[] data)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TransactionOptions.ReadOnly parseFrom(byte[] data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TransactionOptions.ReadOnly parseFrom(InputStream input)
                                             throws IOException

Throws:

IOException

parseFrom

public static TransactionOptions.ReadOnly parseFrom(InputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static TransactionOptions.ReadOnly parseDelimitedFrom(InputStream input)
                                                      throws IOException

Throws:

IOException

parseDelimitedFrom

public static TransactionOptions.ReadOnly parseDelimitedFrom(InputStream input,
                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                      throws IOException

Throws:

IOException

parseFrom

public static TransactionOptions.ReadOnly parseFrom(com.google.protobuf.CodedInputStream input)
                                             throws IOException

Throws:

IOException

parseFrom

public static TransactionOptions.ReadOnly parseFrom(com.google.protobuf.CodedInputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException

Throws:

IOException

newBuilderForType

public TransactionOptions.ReadOnly.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static TransactionOptions.ReadOnly.Builder newBuilder()

newBuilder

public static TransactionOptions.ReadOnly.Builder newBuilder(TransactionOptions.ReadOnly prototype)

toBuilder

public TransactionOptions.ReadOnly.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected TransactionOptions.ReadOnly.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static TransactionOptions.ReadOnly getDefaultInstance()

parser

public static com.google.protobuf.Parser<TransactionOptions.ReadOnly> parser()

getParserForType

public com.google.protobuf.Parser<TransactionOptions.ReadOnly> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public TransactionOptions.ReadOnly getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder