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)	Acknowledge a watch.
final AckWatchResponse	ackWatch(Function<AckWatchRequest.Builder,ObjectBuilder<AckWatchRequest>> fn)	Acknowledge a watch.
ActivateWatchResponse	activateWatch(ActivateWatchRequest request)	Activate a watch.
final ActivateWatchResponse	activateWatch(Function<ActivateWatchRequest.Builder,ObjectBuilder<ActivateWatchRequest>> fn)	Activate a watch.
DeactivateWatchResponse	deactivateWatch(DeactivateWatchRequest request)	Deactivate a watch.
final DeactivateWatchResponse	deactivateWatch(Function<DeactivateWatchRequest.Builder,ObjectBuilder<DeactivateWatchRequest>> fn)	Deactivate a watch.
DeleteWatchResponse	deleteWatch(DeleteWatchRequest request)	Delete a watch.
final DeleteWatchResponse	deleteWatch(Function<DeleteWatchRequest.Builder,ObjectBuilder<DeleteWatchRequest>> fn)	Delete a watch.
ExecuteWatchResponse	executeWatch()	Run a watch.
ExecuteWatchResponse	executeWatch(ExecuteWatchRequest request)	Run a watch.
final ExecuteWatchResponse	executeWatch(Function<ExecuteWatchRequest.Builder,ObjectBuilder<ExecuteWatchRequest>> fn)	Run a watch.
GetWatcherSettingsResponse	getSettings()	Get Watcher index settings.
GetWatcherSettingsResponse	getSettings(GetWatcherSettingsRequest request)	Get Watcher index settings.
final GetWatcherSettingsResponse	getSettings(Function<GetWatcherSettingsRequest.Builder,ObjectBuilder<GetWatcherSettingsRequest>> fn)	Get Watcher index settings.
GetWatchResponse	getWatch(GetWatchRequest request)	Get a watch.
final GetWatchResponse	getWatch(Function<GetWatchRequest.Builder,ObjectBuilder<GetWatchRequest>> fn)	Get a watch.
PutWatchResponse	putWatch(PutWatchRequest request)	Create or update a watch.
final PutWatchResponse	putWatch(Function<PutWatchRequest.Builder,ObjectBuilder<PutWatchRequest>> fn)	Create or update a watch.
QueryWatchesResponse	queryWatches()	Query watches.
QueryWatchesResponse	queryWatches(QueryWatchesRequest request)	Query watches.
final QueryWatchesResponse	queryWatches(Function<QueryWatchesRequest.Builder,ObjectBuilder<QueryWatchesRequest>> fn)	Query watches.
StartWatcherResponse	start()	Start the watch service.
StartWatcherResponse	start(StartWatcherRequest request)	Start the watch service.
final StartWatcherResponse	start(Function<StartWatcherRequest.Builder,ObjectBuilder<StartWatcherRequest>> fn)	Start the watch service.
WatcherStatsResponse	stats()	Get Watcher statistics.
WatcherStatsResponse	stats(WatcherStatsRequest request)	Get Watcher statistics.
final WatcherStatsResponse	stats(Function<WatcherStatsRequest.Builder,ObjectBuilder<WatcherStatsRequest>> fn)	Get Watcher statistics.
StopWatcherResponse	stop()	Stop the watch service.
StopWatcherResponse	stop(StopWatcherRequest request)	Stop the watch service.
final StopWatcherResponse	stop(Function<StopWatcherRequest.Builder,ObjectBuilder<StopWatcherRequest>> fn)	Stop the watch service.
UpdateSettingsResponse	updateSettings()	Update Watcher index settings.
UpdateSettingsResponse	updateSettings(UpdateSettingsRequest request)	Update Watcher index settings.
final UpdateSettingsResponse	updateSettings(Function<UpdateSettingsRequest.Builder,ObjectBuilder<UpdateSettingsRequest>> fn)	Update Watcher index settings.
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

Acknowledge a watch. Acknowledging a watch enables you to manually throttle the execution of the watch's actions.

The acknowledgement state of an action is stored in the status.actions.<id>.ack.state structure.

IMPORTANT: If the specified watch is currently being executed, this API will return an error The reason for this behavior is to prevent overwriting the watch status from a watch execution.

Acknowledging an action throttles further executions of that action until its ack.state is reset to awaits_successful_execution. This happens when the condition of the watch is not met (the condition evaluates to false). To demonstrate how throttling works in practice and how it can be configured for individual actions within a watch, refer to External documentation.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

ackWatch

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

Acknowledge a watch. Acknowledging a watch enables you to manually throttle the execution of the watch's actions.

The acknowledgement state of an action is stored in the status.actions.<id>.ack.state structure.

IMPORTANT: If the specified watch is currently being executed, this API will return an error The reason for this behavior is to prevent overwriting the watch status from a watch execution.

Acknowledging an action throttles further executions of that action until its ack.state is reset to awaits_successful_execution. This happens when the condition of the watch is not met (the condition evaluates to false). To demonstrate how throttling works in practice and how it can be configured for individual actions within a watch, refer to External documentation.

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

Activate a watch. A watch can be either active or inactive.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

activateWatch

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

Activate a watch. A watch can be either active or inactive.

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

Deactivate a watch. A watch can be either active or inactive.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deactivateWatch

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

Deactivate a watch. A watch can be either active or inactive.

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

Delete a watch. When the watch is removed, the document representing the watch in the .watches index is gone and it will never be run again.

Deleting a watch does not delete any watch execution records related to this watch from the watch history.

IMPORTANT: Deleting a watch must be done by using only this API. Do not delete the watch directly from the .watches index using the Elasticsearch delete document API When Elasticsearch security features are enabled, make sure no write privileges are granted to anyone for the .watches index.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteWatch

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

Delete a watch. When the watch is removed, the document representing the watch in the .watches index is gone and it will never be run again.

Deleting a watch does not delete any watch execution records related to this watch from the watch history.

IMPORTANT: Deleting a watch must be done by using only this API. Do not delete the watch directly from the .watches index using the Elasticsearch delete document API When Elasticsearch security features are enabled, make sure no write privileges are granted to anyone for the .watches index.

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

Run a watch. This API can be used to force execution of the watch outside of its triggering logic or to simulate the watch execution for debugging purposes.

For testing and debugging purposes, you also have fine-grained control on how the watch runs. You can run the watch without running all of its actions or alternatively by simulating them. You can also force execution by ignoring the watch condition and control whether a watch record would be written to the watch history after it runs.

You can use the run watch API to run watches that are not yet registered by specifying the watch definition inline. This serves as great tool for testing and debugging your watches prior to adding them to Watcher.

When Elasticsearch security features are enabled on your cluster, watches are run with the privileges of the user that stored the watches. If your user is allowed to read index a, but not index b, then the exact same set of rules will apply during execution of a watch.

When using the run watch API, the authorization data of the user that called the API will be used as a base, instead of the information who stored the watch. Refer to the external documentation for examples of watch execution requests, including existing, customized, and inline watches.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

executeWatch

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

Run a watch. This API can be used to force execution of the watch outside of its triggering logic or to simulate the watch execution for debugging purposes.

For testing and debugging purposes, you also have fine-grained control on how the watch runs. You can run the watch without running all of its actions or alternatively by simulating them. You can also force execution by ignoring the watch condition and control whether a watch record would be written to the watch history after it runs.

You can use the run watch API to run watches that are not yet registered by specifying the watch definition inline. This serves as great tool for testing and debugging your watches prior to adding them to Watcher.

When Elasticsearch security features are enabled on your cluster, watches are run with the privileges of the user that stored the watches. If your user is allowed to read index a, but not index b, then the exact same set of rules will apply during execution of a watch.

When using the run watch API, the authorization data of the user that called the API will be used as a base, instead of the information who stored the watch. Refer to the external documentation for examples of watch execution requests, including existing, customized, and inline watches.

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

Run a watch. This API can be used to force execution of the watch outside of its triggering logic or to simulate the watch execution for debugging purposes.

For testing and debugging purposes, you also have fine-grained control on how the watch runs. You can run the watch without running all of its actions or alternatively by simulating them. You can also force execution by ignoring the watch condition and control whether a watch record would be written to the watch history after it runs.

You can use the run watch API to run watches that are not yet registered by specifying the watch definition inline. This serves as great tool for testing and debugging your watches prior to adding them to Watcher.

When Elasticsearch security features are enabled on your cluster, watches are run with the privileges of the user that stored the watches. If your user is allowed to read index a, but not index b, then the exact same set of rules will apply during execution of a watch.

When using the run watch API, the authorization data of the user that called the API will be used as a base, instead of the information who stored the watch. Refer to the external documentation for examples of watch execution requests, including existing, customized, and inline watches.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getSettings

public GetWatcherSettingsResponse getSettings(GetWatcherSettingsRequest request)
                                       throws IOException,
ElasticsearchException

Get Watcher index settings. Get settings for the Watcher internal index (.watches). Only a subset of settings are shown, for example index.auto_expand_replicas and index.number_of_replicas.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getSettings

public final GetWatcherSettingsResponse getSettings(Function<GetWatcherSettingsRequest.Builder,ObjectBuilder<GetWatcherSettingsRequest>> fn)
                                             throws IOException,
ElasticsearchException

Get Watcher index settings. Get settings for the Watcher internal index (.watches). Only a subset of settings are shown, for example index.auto_expand_replicas and index.number_of_replicas.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getSettings

public GetWatcherSettingsResponse getSettings()
                                       throws IOException,
ElasticsearchException

Get Watcher index settings. Get settings for the Watcher internal index (.watches). Only a subset of settings are shown, for example index.auto_expand_replicas and index.number_of_replicas.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getWatch

public GetWatchResponse getWatch(GetWatchRequest request)
                          throws IOException,
ElasticsearchException

Get a watch.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getWatch

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

Get a watch.

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

Create or update a watch. When a watch is registered, a new document that represents the watch is added to the .watches index and its trigger is immediately registered with the relevant trigger engine. Typically for the schedule trigger, the scheduler is the trigger engine.

IMPORTANT: You must use Kibana or this API to create a watch. Do not add a watch directly to the .watches index by using the Elasticsearch index API. If Elasticsearch security features are enabled, do not give users write privileges on the .watches index.

When you add a watch you can also define its initial active state by setting the active parameter.

When Elasticsearch security features are enabled, your watch can index or search only on indices for which the user that stored the watch has privileges. If the user is able to read index a, but not index b, the same will apply when the watch runs.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putWatch

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

Create or update a watch. When a watch is registered, a new document that represents the watch is added to the .watches index and its trigger is immediately registered with the relevant trigger engine. Typically for the schedule trigger, the scheduler is the trigger engine.

IMPORTANT: You must use Kibana or this API to create a watch. Do not add a watch directly to the .watches index by using the Elasticsearch index API. If Elasticsearch security features are enabled, do not give users write privileges on the .watches index.

When you add a watch you can also define its initial active state by setting the active parameter.

When Elasticsearch security features are enabled, your watch can index or search only on indices for which the user that stored the watch has privileges. If the user is able to read index a, but not index b, the same will apply when the watch runs.

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

Query watches. Get all registered watches in a paginated manner and optionally filter watches by a query.

Note that only the _id and metadata.* fields are queryable or sortable.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

queryWatches

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

Query watches. Get all registered watches in a paginated manner and optionally filter watches by a query.

Note that only the _id and metadata.* fields are queryable or sortable.

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

Query watches. Get all registered watches in a paginated manner and optionally filter watches by a query.

Note that only the _id and metadata.* fields are queryable or sortable.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

start

public StartWatcherResponse start(StartWatcherRequest request)
                           throws IOException,
ElasticsearchException

Start the watch service. Start the Watcher service if it is not already running.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

start

public final StartWatcherResponse start(Function<StartWatcherRequest.Builder,ObjectBuilder<StartWatcherRequest>> fn)
                                 throws IOException,
ElasticsearchException

Start the watch service. Start the Watcher service if it is not already running.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

start

public StartWatcherResponse start()
                           throws IOException,
ElasticsearchException

Start the watch service. Start the Watcher service if it is not already running.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stats

public WatcherStatsResponse stats(WatcherStatsRequest request)
                           throws IOException,
ElasticsearchException

Get Watcher statistics. This API always returns basic metrics. You retrieve more metrics by using the metric parameter.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stats

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

Get Watcher statistics. This API always returns basic metrics. You retrieve more metrics by using the metric parameter.

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

Get Watcher statistics. This API always returns basic metrics. You retrieve more metrics by using the metric parameter.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stop

public StopWatcherResponse stop(StopWatcherRequest request)
                         throws IOException,
ElasticsearchException

Stop the watch service. Stop the Watcher service if it is running.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stop

public final StopWatcherResponse stop(Function<StopWatcherRequest.Builder,ObjectBuilder<StopWatcherRequest>> fn)
                               throws IOException,
ElasticsearchException

Stop the watch service. Stop the Watcher service if it is running.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stop

public StopWatcherResponse stop()
                         throws IOException,
ElasticsearchException

Stop the watch service. Stop the Watcher service if it is running.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateSettings

public UpdateSettingsResponse updateSettings(UpdateSettingsRequest request)
                                      throws IOException,
ElasticsearchException

Update Watcher index settings. Update settings for the Watcher internal index (.watches). Only a subset of settings can be modified. This includes index.auto_expand_replicas, index.number_of_replicas, index.routing.allocation.exclude.*, index.routing.allocation.include.* and index.routing.allocation.require.*. Modification of index.routing.allocation.include._tier_preference is an exception and is not allowed as the Watcher shards must always be in the data_content tier.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateSettings

public final UpdateSettingsResponse updateSettings(Function<UpdateSettingsRequest.Builder,ObjectBuilder<UpdateSettingsRequest>> fn)
                                            throws IOException,
ElasticsearchException

Update Watcher index settings. Update settings for the Watcher internal index (.watches). Only a subset of settings can be modified. This includes index.auto_expand_replicas, index.number_of_replicas, index.routing.allocation.exclude.*, index.routing.allocation.include.* and index.routing.allocation.require.*. Modification of index.routing.allocation.include._tier_preference is an exception and is not allowed as the Watcher shards must always be in the data_content tier.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

updateSettings

public UpdateSettingsResponse updateSettings()
                                      throws IOException,
ElasticsearchException

Update Watcher index settings. Update settings for the Watcher internal index (.watches). Only a subset of settings can be modified. This includes index.auto_expand_replicas, index.number_of_replicas, index.routing.allocation.exclude.*, index.routing.allocation.include.* and index.routing.allocation.require.*. Modification of index.routing.allocation.include._tier_preference is an exception and is not allowed as the Watcher shards must always be in the data_content tier.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co