Package com.linecorp.centraldogma.client

Class WatchRequest<T>

java.lang.Object

com.linecorp.centraldogma.client.WatchRequest<T>

public final class WatchRequest<T>
extends Object

Prepares to send a CentralDogma.watchFile(String, String, Revision, Query, long, boolean) request to the Central Dogma repository or create a new Watcher.

Method Summary

Modifier and Type	Method	Description
WatchRequest<T>	errorOnEntryNotFound(boolean errorOnEntryNotFound)	Sets whether to throw an EntryNotFoundException if the watch target does not exist.
CompletableFuture<Entry<T>>	start()	Waits for the file matched by the Query to be changed since the Revision.HEAD.
CompletableFuture<Entry<T>>	start(Revision lastKnownRevision)	Waits for the file matched by the Query to be changed since the lastKnownRevision.
WatchRequest<T>	timeout(Duration timeout)
WatchRequest<T>	timeoutMillis(long timeoutMillis)

Methods inherited from class java.lang.Object

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

Method Details

timeout

public WatchRequest<T> timeout(Duration timeout)

timeoutMillis

public WatchRequest<T> timeoutMillis(long timeoutMillis)

errorOnEntryNotFound

public WatchRequest<T> errorOnEntryNotFound(boolean errorOnEntryNotFound)

Sets whether to throw an EntryNotFoundException if the watch target does not exist.

start

public CompletableFuture<Entry<T>> start()

Waits for the file matched by the Query to be changed since the Revision.HEAD. If no changes were made within the timeoutMillis(long), the returned CompletableFuture will be completed with null.

Returns:

the Entry which contains the latest known Query result. null if the file was not changed for timeoutMillis(long) milliseconds since the invocation of this method. EntryNotFoundException is raised if the target does not exist.

start

public CompletableFuture<Entry<T>> start(Revision lastKnownRevision)

Waits for the file matched by the Query to be changed since the lastKnownRevision. If no changes were made within the timeoutMillis(long), the returned CompletableFuture will be completed with null.

Returns:

the Entry which contains the latest known Query result. null if the file was not changed for timeoutMillis(long) milliseconds since the invocation of this method. EntryNotFoundException is raised if the target does not exist.