Class TransactionOptions.ReadOnlyOptionsBuilder (3.1.0)

public static final class TransactionOptions.ReadOnlyOptionsBuilder extends TransactionOptions.Builder<TransactionOptions.ReadOnlyOptionsBuilder>

A typesafe builder class representing those options that are applicable when configuring a transaction to be read-only. All methods function as "set" rather than returning a new copy with a value set on it.

Inheritance

java.lang.Object > TransactionOptions.Builder > TransactionOptions.ReadOnlyOptionsBuilder

Inherited Members

TransactionOptions.Builder.build()

TransactionOptions.Builder.getExecutor()

TransactionOptions.Builder.setExecutor(Executor)

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)

Methods

build()

public TransactionOptions build()

Returns

Type	Description
TransactionOptions

Overrides

TransactionOptions.Builder<B>.build()

getReadTime()

public TimestampOrBuilder getReadTime()

Returns

Type	Description
TimestampOrBuilder	the currently set value that will be used as the readTime.

setReadTime(TimestampOrBuilder readTime)

public TransactionOptions.ReadOnlyOptionsBuilder setReadTime(TimestampOrBuilder readTime)

Specify to read documents at the given time. This may not be more than 60 seconds in the past from when the request is processed by the server.

Parameter

Name	Description
readTime	`TimestampOrBuilder` The specific time to read documents at. Must not be older than 60 seconds. A null value means read most up to date data.

Returns

Type	Description
TransactionOptions.ReadOnlyOptionsBuilder	`this` builder