Package co.elastic.clients.elasticsearch.watcher

Class ElasticsearchWatcherClient

java.lang.Object

co.elastic.clients.ApiClient<ElasticsearchTransport,ElasticsearchWatcherClient>

co.elastic.clients.elasticsearch.watcher.ElasticsearchWatcherClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchWatcherClient
extends ApiClient<ElasticsearchTransport,ElasticsearchWatcherClient>

Client for the watcher namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
ElasticsearchWatcherClient(ElasticsearchTransport transport)
ElasticsearchWatcherClient(ElasticsearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
AckWatchResponse	ackWatch(AckWatchRequest request)	Acknowledges a watch, manually throttling the execution of the watch's actions.
final AckWatchResponse	ackWatch(Function<AckWatchRequest.Builder,ObjectBuilder<AckWatchRequest>> fn)	Acknowledges a watch, manually throttling the execution of the watch's actions.
ActivateWatchResponse	activateWatch(ActivateWatchRequest request)	Activates a currently inactive watch.
final ActivateWatchResponse	activateWatch(Function<ActivateWatchRequest.Builder,ObjectBuilder<ActivateWatchRequest>> fn)	Activates a currently inactive watch.
DeactivateWatchResponse	deactivateWatch(DeactivateWatchRequest request)	Deactivates a currently active watch.
final DeactivateWatchResponse	deactivateWatch(Function<DeactivateWatchRequest.Builder,ObjectBuilder<DeactivateWatchRequest>> fn)	Deactivates a currently active watch.
DeleteWatchResponse	deleteWatch(DeleteWatchRequest request)	Removes a watch from Watcher.
final DeleteWatchResponse	deleteWatch(Function<DeleteWatchRequest.Builder,ObjectBuilder<DeleteWatchRequest>> fn)	Removes a watch from Watcher.
ExecuteWatchResponse	executeWatch()	Forces the execution of a stored watch.
ExecuteWatchResponse	executeWatch(ExecuteWatchRequest request)	Forces the execution of a stored watch.
final ExecuteWatchResponse	executeWatch(Function<ExecuteWatchRequest.Builder,ObjectBuilder<ExecuteWatchRequest>> fn)	Forces the execution of a stored watch.
GetWatchResponse	getWatch(GetWatchRequest request)	Retrieves a watch by its ID.
final GetWatchResponse	getWatch(Function<GetWatchRequest.Builder,ObjectBuilder<GetWatchRequest>> fn)	Retrieves a watch by its ID.
PutWatchResponse	putWatch(PutWatchRequest request)	Creates a new watch, or updates an existing one.
final PutWatchResponse	putWatch(Function<PutWatchRequest.Builder,ObjectBuilder<PutWatchRequest>> fn)	Creates a new watch, or updates an existing one.
QueryWatchesResponse	queryWatches()	Retrieves stored watches.
QueryWatchesResponse	queryWatches(QueryWatchesRequest request)	Retrieves stored watches.
final QueryWatchesResponse	queryWatches(Function<QueryWatchesRequest.Builder,ObjectBuilder<QueryWatchesRequest>> fn)	Retrieves stored watches.
StartWatcherResponse	start()	Starts Watcher if it is not already running.
WatcherStatsResponse	stats()	Retrieves the current Watcher metrics.
WatcherStatsResponse	stats(WatcherStatsRequest request)	Retrieves the current Watcher metrics.
final WatcherStatsResponse	stats(Function<WatcherStatsRequest.Builder,ObjectBuilder<WatcherStatsRequest>> fn)	Retrieves the current Watcher metrics.
StopWatcherResponse	stop()	Stops Watcher if it is running.
ElasticsearchWatcherClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class co.elastic.clients.ApiClient

_jsonpMapper, _transport, _transportOptions, close, getDeserializer, withTransportOptions

Methods inherited from class java.lang.Object

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

Constructor Details

ElasticsearchWatcherClient

public ElasticsearchWatcherClient(ElasticsearchTransport transport)

ElasticsearchWatcherClient

public ElasticsearchWatcherClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchWatcherClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchWatcherClient>

ackWatch

public AckWatchResponse ackWatch(AckWatchRequest request)
                          throws IOException,
ElasticsearchException

Acknowledges a watch, manually throttling the execution of the watch's actions.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

ackWatch

public final AckWatchResponse ackWatch(Function<AckWatchRequest.Builder,ObjectBuilder<AckWatchRequest>> fn)
                                throws IOException,
ElasticsearchException

Acknowledges a watch, manually throttling the execution of the watch's actions.

Parameters:

fn - a function that initializes a builder to create the AckWatchRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

activateWatch

public ActivateWatchResponse activateWatch(ActivateWatchRequest request)
                                    throws IOException,
ElasticsearchException

Activates a currently inactive watch.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

activateWatch

public final ActivateWatchResponse activateWatch(Function<ActivateWatchRequest.Builder,ObjectBuilder<ActivateWatchRequest>> fn)
                                          throws IOException,
ElasticsearchException

Activates a currently inactive watch.

Parameters:

fn - a function that initializes a builder to create the ActivateWatchRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deactivateWatch

public DeactivateWatchResponse deactivateWatch(DeactivateWatchRequest request)
                                        throws IOException,
ElasticsearchException

Deactivates a currently active watch.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deactivateWatch

public final DeactivateWatchResponse deactivateWatch(Function<DeactivateWatchRequest.Builder,ObjectBuilder<DeactivateWatchRequest>> fn)
                                              throws IOException,
ElasticsearchException

Deactivates a currently active watch.

Parameters:

fn - a function that initializes a builder to create the DeactivateWatchRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteWatch

public DeleteWatchResponse deleteWatch(DeleteWatchRequest request)
                                throws IOException,
ElasticsearchException

Removes a watch from Watcher.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteWatch

public final DeleteWatchResponse deleteWatch(Function<DeleteWatchRequest.Builder,ObjectBuilder<DeleteWatchRequest>> fn)
                                      throws IOException,
ElasticsearchException

Removes a watch from Watcher.

Parameters:

fn - a function that initializes a builder to create the DeleteWatchRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

executeWatch

public ExecuteWatchResponse executeWatch(ExecuteWatchRequest request)
                                  throws IOException,
ElasticsearchException

Forces the execution of a stored watch.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

executeWatch

public final ExecuteWatchResponse executeWatch(Function<ExecuteWatchRequest.Builder,ObjectBuilder<ExecuteWatchRequest>> fn)
                                        throws IOException,
ElasticsearchException

Forces the execution of a stored watch.

Parameters:

fn - a function that initializes a builder to create the ExecuteWatchRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

executeWatch

public ExecuteWatchResponse executeWatch()
                                  throws IOException,
ElasticsearchException

Forces the execution of a stored watch.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getWatch

public GetWatchResponse getWatch(GetWatchRequest request)
                          throws IOException,
ElasticsearchException

Retrieves a watch by its ID.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getWatch

public final GetWatchResponse getWatch(Function<GetWatchRequest.Builder,ObjectBuilder<GetWatchRequest>> fn)
                                throws IOException,
ElasticsearchException

Retrieves a watch by its ID.

Parameters:

fn - a function that initializes a builder to create the GetWatchRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putWatch

public PutWatchResponse putWatch(PutWatchRequest request)
                          throws IOException,
ElasticsearchException

Creates a new watch, or updates an existing one.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putWatch

public final PutWatchResponse putWatch(Function<PutWatchRequest.Builder,ObjectBuilder<PutWatchRequest>> fn)
                                throws IOException,
ElasticsearchException

Creates a new watch, or updates an existing one.

Parameters:

fn - a function that initializes a builder to create the PutWatchRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

queryWatches

public QueryWatchesResponse queryWatches(QueryWatchesRequest request)
                                  throws IOException,
ElasticsearchException

Retrieves stored watches.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

queryWatches

public final QueryWatchesResponse queryWatches(Function<QueryWatchesRequest.Builder,ObjectBuilder<QueryWatchesRequest>> fn)
                                        throws IOException,
ElasticsearchException

Retrieves stored watches.

Parameters:

fn - a function that initializes a builder to create the QueryWatchesRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

queryWatches

public QueryWatchesResponse queryWatches()
                                  throws IOException,
ElasticsearchException

Retrieves stored watches.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

start

public StartWatcherResponse start()
                           throws IOException,
ElasticsearchException

Starts Watcher if it is not already running.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stats

public WatcherStatsResponse stats(WatcherStatsRequest request)
                           throws IOException,
ElasticsearchException

Retrieves the current Watcher metrics.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stats

public final WatcherStatsResponse stats(Function<WatcherStatsRequest.Builder,ObjectBuilder<WatcherStatsRequest>> fn)
                                 throws IOException,
ElasticsearchException

Retrieves the current Watcher metrics.

Parameters:

fn - a function that initializes a builder to create the WatcherStatsRequest

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stats

public WatcherStatsResponse stats()
                           throws IOException,
ElasticsearchException

Retrieves the current Watcher metrics.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stop

public StopWatcherResponse stop()
                         throws IOException,
ElasticsearchException

Stops Watcher if it is running.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co