com.google.cloud.firestore

Class TransactionOptions.ReadOnlyOptionsBuilder

java.lang.Object

com.google.cloud.firestore.TransactionOptions.Builder<TransactionOptions.ReadOnlyOptionsBuilder>

com.google.cloud.firestore.TransactionOptions.ReadOnlyOptionsBuilder

Enclosing class:

TransactionOptions

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.

Field Summary

Fields inherited from class com.google.cloud.firestore.TransactionOptions.Builder

executor

Method Summary

Modifier and Type	Method and Description
TransactionOptions	build()
com.google.protobuf.TimestampOrBuilder	getReadTime()
TransactionOptions.ReadOnlyOptionsBuilder	setReadTime(com.google.protobuf.TimestampOrBuilder readTime) Specify to read documents at the given time.

Methods inherited from class com.google.cloud.firestore.TransactionOptions.Builder

getExecutor, setExecutor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getReadTime

@Nullable
public com.google.protobuf.TimestampOrBuilder getReadTime()

Returns:

the currently set value that will be used as the readTime.

setReadTime

@Nonnull
public TransactionOptions.ReadOnlyOptionsBuilder setReadTime(@Nullable
                                                                      com.google.protobuf.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.

Parameters:

readTime - 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:

this builder

build

@Nonnull
public TransactionOptions build()

Specified by:

build in class TransactionOptions.Builder<TransactionOptions.ReadOnlyOptionsBuilder>

Returns:

an instance of TransactionOptions from the values passed to this builder