Package org.elasticsearch.client

Class WatcherClient

java.lang.Object

org.elasticsearch.client.WatcherClient

public final class WatcherClient
extends Object

Method Summary

Modifier and Type	Method	Description
AckWatchResponse	ackWatch(AckWatchRequest request, RequestOptions options)	Acknowledges a watch.
Cancellable	ackWatchAsync(AckWatchRequest request, RequestOptions options, ActionListener<AckWatchResponse> listener)	Asynchronously acknowledges a watch.
ActivateWatchResponse	activateWatch(ActivateWatchRequest request, RequestOptions options)	Activate a watch from the cluster See the docs for more.
Cancellable	activateWatchAsync(ActivateWatchRequest request, RequestOptions options, ActionListener<ActivateWatchResponse> listener)	Asynchronously activates a watch from the cluster See the docs for more.
DeactivateWatchResponse	deactivateWatch(DeactivateWatchRequest request, RequestOptions options)	Deactivate an existing watch See the docs for more.
Cancellable	deactivateWatchAsync(DeactivateWatchRequest request, RequestOptions options, ActionListener<DeactivateWatchResponse> listener)	Asynchronously deactivate an existing watch See the docs for more.
DeleteWatchResponse	deleteWatch(DeleteWatchRequest request, RequestOptions options)	Deletes a watch from the cluster See the docs for more.
Cancellable	deleteWatchAsync(DeleteWatchRequest request, RequestOptions options, ActionListener<DeleteWatchResponse> listener)	Asynchronously deletes a watch from the cluster See the docs for more.
ExecuteWatchResponse	executeWatch(ExecuteWatchRequest request, RequestOptions options)	Execute a watch on the cluster See the docs for more.
Cancellable	executeWatchAsync(ExecuteWatchRequest request, RequestOptions options, ActionListener<ExecuteWatchResponse> listener)	Asynchronously execute a watch on the cluster See the docs for more.
GetWatchResponse	getWatch(GetWatchRequest request, RequestOptions options)	Gets a watch from the cluster See the docs for more.
Cancellable	getWatchAsync(GetWatchRequest request, RequestOptions options, ActionListener<GetWatchResponse> listener)	Asynchronously gets a watch into the cluster See the docs for more.
PutWatchResponse	putWatch(PutWatchRequest request, RequestOptions options)	Put a watch into the cluster See the docs for more.
Cancellable	putWatchAsync(PutWatchRequest request, RequestOptions options, ActionListener<PutWatchResponse> listener)	Asynchronously put a watch into the cluster See the docs for more.
AcknowledgedResponse	startWatchService(StartWatchServiceRequest request, RequestOptions options)	Start the watch service See the docs for more.
Cancellable	startWatchServiceAsync(StartWatchServiceRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener)	Asynchronously start the watch service See the docs for more.
AcknowledgedResponse	stopWatchService(StopWatchServiceRequest request, RequestOptions options)	Stop the watch service See the docs for more.
Cancellable	stopWatchServiceAsync(StopWatchServiceRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener)	Asynchronously stop the watch service See the docs for more.
WatcherStatsResponse	watcherStats(WatcherStatsRequest request, RequestOptions options)	Get the watcher stats See the docs for more.
Cancellable	watcherStatsAsync(WatcherStatsRequest request, RequestOptions options, ActionListener<WatcherStatsResponse> listener)	Asynchronously get the watcher stats See the docs for more.

Methods inherited from class java.lang.Object

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

Method Detail

startWatchService

public AcknowledgedResponse startWatchService(StartWatchServiceRequest request,
                                              RequestOptions options)
                                       throws IOException

Start the watch service See the docs for more.

Parameters:

request - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

IOException - in case there is a problem sending the request or parsing back the response

startWatchServiceAsync

public Cancellable startWatchServiceAsync(StartWatchServiceRequest request,
                                          RequestOptions options,
                                          ActionListener<AcknowledgedResponse> listener)

Asynchronously start the watch service See the docs for more.

Parameters:

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

cancellable that may be used to cancel the request

stopWatchService

public AcknowledgedResponse stopWatchService(StopWatchServiceRequest request,
                                             RequestOptions options)
                                      throws IOException

Stop the watch service See the docs for more.

Parameters:

request - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

IOException - in case there is a problem sending the request or parsing back the response

stopWatchServiceAsync

public Cancellable stopWatchServiceAsync(StopWatchServiceRequest request,
                                         RequestOptions options,
                                         ActionListener<AcknowledgedResponse> listener)

Asynchronously stop the watch service See the docs for more.

Parameters:

request - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

cancellable that may be used to cancel the request

putWatch

public PutWatchResponse putWatch(PutWatchRequest request,
                                 RequestOptions options)
                          throws IOException

Put a watch into the cluster See the docs for more.

Parameters:

request - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

IOException - in case there is a problem sending the request or parsing back the response

putWatchAsync

public Cancellable putWatchAsync(PutWatchRequest request,
                                 RequestOptions options,
                                 ActionListener<PutWatchResponse> listener)

Asynchronously put a watch into the cluster See the docs for more.

Parameters:

request - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

getWatch

public GetWatchResponse getWatch(GetWatchRequest request,
                                 RequestOptions options)
                          throws IOException

Gets a watch from the cluster See the docs for more.

Parameters:

request - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

IOException - in case there is a problem sending the request or parsing back the response

getWatchAsync

public Cancellable getWatchAsync(GetWatchRequest request,
                                 RequestOptions options,
                                 ActionListener<GetWatchResponse> listener)

Asynchronously gets a watch into the cluster See the docs for more.

Parameters:

request - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

deactivateWatch

public DeactivateWatchResponse deactivateWatch(DeactivateWatchRequest request,
                                               RequestOptions options)
                                        throws IOException

Deactivate an existing watch See the docs for more.

Parameters:

request - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

IOException - in case there is a problem sending the request or parsing back the response

deactivateWatchAsync

public Cancellable deactivateWatchAsync(DeactivateWatchRequest request,
                                        RequestOptions options,
                                        ActionListener<DeactivateWatchResponse> listener)

Asynchronously deactivate an existing watch See the docs for more.

Parameters:

request - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

deleteWatch

public DeleteWatchResponse deleteWatch(DeleteWatchRequest request,
                                       RequestOptions options)
                                throws IOException

Deletes a watch from the cluster See the docs for more.

Parameters:

request - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

IOException - in case there is a problem sending the request or parsing back the response

deleteWatchAsync

public Cancellable deleteWatchAsync(DeleteWatchRequest request,
                                    RequestOptions options,
                                    ActionListener<DeleteWatchResponse> listener)

Asynchronously deletes a watch from the cluster See the docs for more.

Parameters:

request - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

ackWatch

public AckWatchResponse ackWatch(AckWatchRequest request,
                                 RequestOptions options)
                          throws IOException

Acknowledges a watch. See the docs for more information.

Parameters:

request - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

IOException - if there is a problem sending the request or parsing back the response

ackWatchAsync

public Cancellable ackWatchAsync(AckWatchRequest request,
                                 RequestOptions options,
                                 ActionListener<AckWatchResponse> listener)

Asynchronously acknowledges a watch. See the docs for more information.

Parameters:

request - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon completion of the request

Returns:

cancellable that may be used to cancel the request

activateWatch

public ActivateWatchResponse activateWatch(ActivateWatchRequest request,
                                           RequestOptions options)
                                    throws IOException

Activate a watch from the cluster See the docs for more.

Parameters:

request - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

IOException - in case there is a problem sending the request or parsing back the response

activateWatchAsync

public Cancellable activateWatchAsync(ActivateWatchRequest request,
                                      RequestOptions options,
                                      ActionListener<ActivateWatchResponse> listener)

Asynchronously activates a watch from the cluster See the docs for more.

Parameters:

request - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

executeWatch

public ExecuteWatchResponse executeWatch(ExecuteWatchRequest request,
                                         RequestOptions options)
                                  throws IOException

Execute a watch on the cluster See the docs for more.

Parameters:

request - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

IOException - if there is a problem sending the request or parsing the response

executeWatchAsync

public Cancellable executeWatchAsync(ExecuteWatchRequest request,
                                     RequestOptions options,
                                     ActionListener<ExecuteWatchResponse> listener)

Asynchronously execute a watch on the cluster See the docs for more.

Parameters:

request - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notifed upon request completion

Returns:

cancellable that may be used to cancel the request

watcherStats

public WatcherStatsResponse watcherStats(WatcherStatsRequest request,
                                         RequestOptions options)
                                  throws IOException

Get the watcher stats See the docs for more.

Parameters:

request - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

IOException - in case there is a problem sending the request or parsing back the response

watcherStatsAsync

public Cancellable watcherStatsAsync(WatcherStatsRequest request,
                                     RequestOptions options,
                                     ActionListener<WatcherStatsResponse> listener)

Asynchronously get the watcher stats See the docs for more.

Parameters:

request - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request