com.google.api.services.spanner.v1.model

Class ReadOnly

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.spanner.v1.model.ReadOnly

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class ReadOnly
extends com.google.api.client.json.GenericJson

Message type to initiate a read-only transaction.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Spanner API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ReadOnly()

Method Summary

Modifier and Type	Method and Description
ReadOnly	clone()
String	getExactStaleness() Executes all reads at a timestamp that is `exact_staleness` old.
String	getMaxStaleness() Read data at a timestamp >= `NOW - max_staleness` seconds.
String	getMinReadTimestamp() Executes all reads at a timestamp >= `min_read_timestamp`.
String	getReadTimestamp() Executes all reads at the given timestamp.
Boolean	getReturnReadTimestamp() If true, the Cloud Spanner-selected read timestamp is included in the Transaction message that describes the transaction.
Boolean	getStrong() Read at a timestamp where all previously committed transactions are visible.
ReadOnly	set(String fieldName, Object value)
ReadOnly	setExactStaleness(String exactStaleness) Executes all reads at a timestamp that is `exact_staleness` old.
ReadOnly	setMaxStaleness(String maxStaleness) Read data at a timestamp >= `NOW - max_staleness` seconds.
ReadOnly	setMinReadTimestamp(String minReadTimestamp) Executes all reads at a timestamp >= `min_read_timestamp`.
ReadOnly	setReadTimestamp(String readTimestamp) Executes all reads at the given timestamp.
ReadOnly	setReturnReadTimestamp(Boolean returnReadTimestamp) If true, the Cloud Spanner-selected read timestamp is included in the Transaction message that describes the transaction.
ReadOnly	setStrong(Boolean strong) Read at a timestamp where all previously committed transactions are visible.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

ReadOnly

public ReadOnly()

Method Detail

getExactStaleness

public String 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`.

Returns:

value or null for none

setExactStaleness

public ReadOnly setExactStaleness(String exactStaleness)

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`.

Parameters:

exactStaleness - exactStaleness or null for none

getMaxStaleness

public String 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.

Returns:

value or null for none

setMaxStaleness

public ReadOnly setMaxStaleness(String maxStaleness)

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.

Parameters:

maxStaleness - maxStaleness or null for none

getMinReadTimestamp

public String 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"`.

Returns:

value or null for none

setMinReadTimestamp

public ReadOnly setMinReadTimestamp(String minReadTimestamp)

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"`.

Parameters:

minReadTimestamp - minReadTimestamp or null for none

getReadTimestamp

public String 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 is blocked 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"`.

Returns:

value or null for none

setReadTimestamp

public ReadOnly setReadTimestamp(String readTimestamp)

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 is blocked 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"`.

Parameters:

readTimestamp - readTimestamp or null for none

getReturnReadTimestamp

public Boolean getReturnReadTimestamp()

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

Returns:

value or null for none

setReturnReadTimestamp

public ReadOnly setReturnReadTimestamp(Boolean returnReadTimestamp)

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

Parameters:

returnReadTimestamp - returnReadTimestamp or null for none

getStrong

public Boolean getStrong()

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

Returns:

value or null for none

setStrong

public ReadOnly setStrong(Boolean strong)

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

Parameters:

strong - strong or null for none

set

public ReadOnly set(String fieldName,
                    Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public ReadOnly clone()

Overrides:

clone in class com.google.api.client.json.GenericJson