Class ReadOption (2.22.0)

Version 2.22.0

• 2.24.1 (latest)
• 2.23.0
• 2.22.0
• 2.21.3
• 2.20.2
• 2.19.2
• 2.18.5
• 2.17.6

public abstract class ReadOption implements Serializable

Specifies options for read operations in Datastore, namely getting/fetching entities and running queries.

Inheritance

java.lang.Object > ReadOption

Implements

Serializable

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

eventualConsistency()

public static ReadOption.EventualConsistency eventualConsistency()

Returns a ReadOption that specifies eventual consistency, allowing Datastore to return stale results from gets, fetches, and ancestor queries.

Returns
Type	Description
ReadOption.EventualConsistency

readTime(Timestamp time)

public static ReadOption.ReadTime readTime(Timestamp time)

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Returns a ReadOption that specifies read time, allowing Datastore to return results from lookups and queries at a particular timestamp. This feature is currently in private preview.

Parameter
Name	Description
time	com.google.cloud.Timestamp

Returns
Type	Description
ReadOption.ReadTime

transactionId(ByteString transactionId)

public static ReadOption transactionId(ByteString transactionId)

Internal Only: This feature is not stable for application use.

Returns a ReadOption that specifies transaction id, allowing Datastore to execute a Query in this transaction.

Parameter
Name	Description
transactionId	ByteString

Returns
Type	Description
ReadOption

transactionId(String transactionId)

public static ReadOption transactionId(String transactionId)

Internal Only: This feature is not stable for application use.

Returns a ReadOption that specifies transaction id, allowing Datastore to execute a Query in this transaction.

Parameter
Name	Description
transactionId	String

Returns
Type	Description
ReadOption