mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-24 23:27:25 -04:00
255c9a7f95
**Problem:** For historical reasons, source files for the Elasticsearch Guide's security, watcher, and Logstash API docs are housed in the `x-pack/docs` directory. This can confuse new contributors who expect Elasticsearch Guide docs to be located in `docs/reference`. **Solution:** - Move the security, watcher, and Logstash API doc source files to the `docs/reference` directory - Update doc snippet tests to use security Rel: https://github.com/elastic/platform-docs-team/issues/208
25 lines
1,003 B
Text
25 lines
1,003 B
Text
[discrete]
|
|
[[api-java-deactivate-watch]]
|
|
=== Deactivate watch API
|
|
|
|
A watch can be either <<watch-active-state,active or inactive>>. This API
|
|
enables you to deactivate a currently active watch.
|
|
|
|
The status of an active watch is returned with the watch definition
|
|
when you call the <<api-java-get-watch,get watch API>>:
|
|
|
|
[source,java]
|
|
--------------------------------------------------
|
|
GetWatchResponse getWatchResponse = watcherClient.prepareGetWatch("my-watch").get();
|
|
boolean active = getWatchResponse.getStatus().state().isActive();
|
|
--------------------------------------------------
|
|
|
|
The following snippet shows how you can deactivate a watch:
|
|
|
|
[source,java]
|
|
--------------------------------------------------
|
|
ActivateWatchResponse activateResponse = watcherClient.prepareActivateWatch("my-watch", false).get();
|
|
boolean active = activateResponse.getStatus().state().isActive();
|
|
--------------------------------------------------
|
|
|
|
The new state of the watch is returned as part of its overall status.
|