Package co.elastic.clients.elasticsearch.watcher

Class ElasticsearchWatcherAsyncClient

java.lang.Object

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

co.elastic.clients.elasticsearch.watcher.ElasticsearchWatcherAsyncClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class ElasticsearchWatcherAsyncClient
extends ApiClient<ElasticsearchTransport,ElasticsearchWatcherAsyncClient>

Client for the watcher namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

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

ElasticsearchWatcherAsyncClient

public ElasticsearchWatcherAsyncClient(ElasticsearchTransport transport)

ElasticsearchWatcherAsyncClient

public ElasticsearchWatcherAsyncClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchWatcherAsyncClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchWatcherAsyncClient>

ackWatch

public CompletableFuture<AckWatchResponse> ackWatch(AckWatchRequest request)

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).

See Also:

• Documentation on elastic.co

ackWatch

public final CompletableFuture<AckWatchResponse> ackWatch(Function<AckWatchRequest.Builder,ObjectBuilder<AckWatchRequest>> fn)

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).

Parameters:

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

See Also:

• Documentation on elastic.co

activateWatch

public CompletableFuture<ActivateWatchResponse> activateWatch(ActivateWatchRequest request)

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

See Also:

• Documentation on elastic.co

activateWatch

public final CompletableFuture<ActivateWatchResponse> activateWatch(Function<ActivateWatchRequest.Builder,ObjectBuilder<ActivateWatchRequest>> fn)

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

Parameters:

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

See Also:

• Documentation on elastic.co

deactivateWatch

public CompletableFuture<DeactivateWatchResponse> deactivateWatch(DeactivateWatchRequest request)

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

See Also:

• Documentation on elastic.co

deactivateWatch

public final CompletableFuture<DeactivateWatchResponse> deactivateWatch(Function<DeactivateWatchRequest.Builder,ObjectBuilder<DeactivateWatchRequest>> fn)

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

Parameters:

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

See Also:

• Documentation on elastic.co

deleteWatch

public CompletableFuture<DeleteWatchResponse> deleteWatch(DeleteWatchRequest request)

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.

See Also:

• Documentation on elastic.co

deleteWatch

public final CompletableFuture<DeleteWatchResponse> deleteWatch(Function<DeleteWatchRequest.Builder,ObjectBuilder<DeleteWatchRequest>> fn)

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

See Also:

• Documentation on elastic.co

executeWatch

public CompletableFuture<ExecuteWatchResponse> executeWatch(ExecuteWatchRequest request)

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.

See Also:

• Documentation on elastic.co

executeWatch

public final CompletableFuture<ExecuteWatchResponse> executeWatch(Function<ExecuteWatchRequest.Builder,ObjectBuilder<ExecuteWatchRequest>> fn)

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.

Parameters:

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

See Also:

• Documentation on elastic.co

executeWatch

public CompletableFuture<ExecuteWatchResponse> executeWatch()

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.

See Also:

• Documentation on elastic.co

getSettings

public CompletableFuture<GetWatcherSettingsResponse> getSettings(GetWatcherSettingsRequest request)

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.

See Also:

• Documentation on elastic.co

getSettings

public final CompletableFuture<GetWatcherSettingsResponse> getSettings(Function<GetWatcherSettingsRequest.Builder,ObjectBuilder<GetWatcherSettingsRequest>> fn)

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

See Also:

• Documentation on elastic.co

getSettings

public CompletableFuture<GetWatcherSettingsResponse> getSettings()

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.

See Also:

• Documentation on elastic.co

getWatch

public CompletableFuture<GetWatchResponse> getWatch(GetWatchRequest request)

Get a watch.

See Also:

• Documentation on elastic.co

getWatch

public final CompletableFuture<GetWatchResponse> getWatch(Function<GetWatchRequest.Builder,ObjectBuilder<GetWatchRequest>> fn)

Get a watch.

Parameters:

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

See Also:

• Documentation on elastic.co

putWatch

public CompletableFuture<PutWatchResponse> putWatch(PutWatchRequest request)

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.

See Also:

• Documentation on elastic.co

putWatch

public final CompletableFuture<PutWatchResponse> putWatch(Function<PutWatchRequest.Builder,ObjectBuilder<PutWatchRequest>> fn)

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

See Also:

• Documentation on elastic.co

queryWatches

public CompletableFuture<QueryWatchesResponse> queryWatches(QueryWatchesRequest request)

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.

See Also:

• Documentation on elastic.co

queryWatches

public final CompletableFuture<QueryWatchesResponse> queryWatches(Function<QueryWatchesRequest.Builder,ObjectBuilder<QueryWatchesRequest>> fn)

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

See Also:

• Documentation on elastic.co

queryWatches

public CompletableFuture<QueryWatchesResponse> queryWatches()

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.

See Also:

• Documentation on elastic.co

start

public CompletableFuture<StartWatcherResponse> start(StartWatcherRequest request)

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

See Also:

• Documentation on elastic.co

start

public final CompletableFuture<StartWatcherResponse> start(Function<StartWatcherRequest.Builder,ObjectBuilder<StartWatcherRequest>> fn)

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

See Also:

• Documentation on elastic.co

start

public CompletableFuture<StartWatcherResponse> start()

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

See Also:

• Documentation on elastic.co

stats

public CompletableFuture<WatcherStatsResponse> stats(WatcherStatsRequest request)

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

See Also:

• Documentation on elastic.co

stats

public final CompletableFuture<WatcherStatsResponse> stats(Function<WatcherStatsRequest.Builder,ObjectBuilder<WatcherStatsRequest>> fn)

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

See Also:

• Documentation on elastic.co

stats

public CompletableFuture<WatcherStatsResponse> stats()

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

See Also:

• Documentation on elastic.co

stop

public CompletableFuture<StopWatcherResponse> stop(StopWatcherRequest request)

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

See Also:

• Documentation on elastic.co

stop

public final CompletableFuture<StopWatcherResponse> stop(Function<StopWatcherRequest.Builder,ObjectBuilder<StopWatcherRequest>> fn)

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

Parameters:

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

See Also:

• Documentation on elastic.co

stop

public CompletableFuture<StopWatcherResponse> stop()

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

See Also:

• Documentation on elastic.co

updateSettings

public CompletableFuture<UpdateSettingsResponse> updateSettings(UpdateSettingsRequest request)

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.

See Also:

• Documentation on elastic.co

updateSettings

public final CompletableFuture<UpdateSettingsResponse> updateSettings(Function<UpdateSettingsRequest.Builder,ObjectBuilder<UpdateSettingsRequest>> fn)

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

See Also:

• Documentation on elastic.co

updateSettings

public CompletableFuture<UpdateSettingsResponse> updateSettings()

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.

See Also:

• Documentation on elastic.co