Package com.linecorp.centraldogma.client

Class WatchFilesRequest

java.lang.Object

com.linecorp.centraldogma.client.WatchFilesRequest

public final class WatchFilesRequest
extends Object

Prepares to send a CentralDogma.watchRepository(String, String, Revision, PathPattern, long, boolean) request to the Central Dogma repository.

Method Summary

Modifier and Type	Method	Description
WatchFilesRequest	errorOnEntryNotFound(boolean errorOnEntryNotFound)	Sets whether to throw an EntryNotFoundException if the watch target does not exist.
CompletableFuture<Revision>	start()	Waits for the files matched by the PathPattern to be changed since the Revision.HEAD.
CompletableFuture<Revision>	start(Revision lastKnownRevision)	Waits for the files matched by the PathPattern to be changed since the lastKnownRevision.
WatchFilesRequest	timeout(Duration timeout)
WatchFilesRequest	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 WatchFilesRequest timeout(Duration timeout)

timeoutMillis

public WatchFilesRequest timeoutMillis(long timeoutMillis)

errorOnEntryNotFound

public WatchFilesRequest errorOnEntryNotFound(boolean errorOnEntryNotFound)

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

start

public CompletableFuture<Revision> start()

Waits for the files matched by the PathPattern 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 latest known Revision which contains the changes for the matched files. null if the files were not changed for timeoutMillis milliseconds since the invocation of this method. EntryNotFoundException is raised if the target does not exist.

start

public CompletableFuture<Revision> start(Revision lastKnownRevision)

Waits for the files matched by the PathPattern 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 latest known Revision which contains the changes for the matched files. null if the files were not changed for timeoutMillis milliseconds since the invocation of this method. EntryNotFoundException is raised if the target does not exist.