IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Deactivate watch API Execute watch API »
Elastic Docs ›Java REST Client [7.13] ›Java High Level REST Client ›Watcher APIs

Activate watch API

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Activate watch API

edit

Execution

edit

A watch can be activated as follows:

ActivateWatchRequest request = new ActivateWatchRequest("my_watch_id");
ActivateWatchResponse response = client.watcher().activateWatch(request, RequestOptions.DEFAULT);

Response

edit

The returned ActivateWatchResponse contains the new status of the activated watch.

WatchStatus watchStatus = response.getStatus();

watchStatus contains status of the watch

Asynchronous execution

edit

This request can be executed asynchronously:

client.watcher().activateWatchAsync(request, RequestOptions.DEFAULT, listener);

The ActivateWatchRequest to execute and the ActionListener to use when the execution completes

The asynchronous method does not block and returns immediately. Once it is completed the ActionListener is called back using the onResponse method if the execution successfully completed or using the onFailure method if it failed.

A typical listener for ActivateWatchResponse looks like:

ActionListener<ActivateWatchResponse> listener = new ActionListener<ActivateWatchResponse>() {
    @Override
    public void onResponse(ActivateWatchResponse response) {
        
    }

    @Override
    public void onFailure(Exception e) {
        
    }
};

Called when the execution is successfully completed. The response is provided as an argument

Called in case of failure. The raised exception is provided as an argument
« Deactivate watch API Execute watch API »