github-mirrors/elasticsearch
1
0
Fork 0
mirror of https://github.com/elastic/elasticsearch.git synced 2025-04-24 23:27:25 -04:00
Code Issues Projects Releases Packages Wiki Activity

Small fixes to the HLRC watcher documentation. (#34306)

Browse source 
* Make sure to use the new docs style for 'ack watch'.
* Replace 'document' with 'watcher' in page names.
This commit is contained in:
Julie Tibshirani 2018-10-04 23:30:20 +02:00 • committed by GitHub
parent 09aaed4fe4
commit a6c5b6807f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 19 additions and 35 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/java-rest/high-level/supported-apis.asciidoc
View file

@ -310,14 +310,14 @@ include::security/change-password.asciidoc[]
== Watcher APIs
:upid: {mainid}-document
:upid: {mainid}-watcher
:doc-tests-file: {doc-tests}/WatcherDocumentationIT.java
The Java High Level REST Client supports the following Watcher APIs:
* <<java-rest-high-x-pack-watcher-put-watch>>
* <<java-rest-high-x-pack-watcher-delete-watch>>
* <<java-rest-high-watcher-ack-watch>>
* <<{upid}-ack-watch>>
* <<{upid}-activate-watch>>
include::watcher/put-watch.asciidoc[]

45
docs/java-rest/high-level/watcher/ack-watch.asciidoc
View file

@ -1,7 +1,13 @@
[[java-rest-high-watcher-ack-watch]]
--
:api: ack-watch
:request: AckWatchRequest
:response: AckWatchResponse
--
[id="{upid}-{api}"]
=== Ack Watch API
[[java-rest-high-watcher-ack-watch-execution]]
[id="{upid}-{api}-request"]
==== Execution
{xpack-ref}/actions.html#actions-ack-throttle[Acknowledging a watch] enables you
@ -10,48 +16,23 @@ through the following request:
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests}/WatcherDocumentationIT.java[ack-watch-execute]
include-tagged::{doc-tests-file}[{api}-request]
--------------------------------------------------
<1> The ID of the watch to ack.
<2> An optional list of IDs representing the watch actions that should be acked.
If no action IDs are provided, then all of the watch's actions will be acked.
[[java-rest-high-watcher-ack-watch-response]]
[id="{upid}-{api}-response"]
==== Response
The returned `AckWatchResponse` contains the new status of the requested watch:
The returned +{response}+ contains the new status of the requested watch:
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests}/WatcherDocumentationIT.java[ack-watch-response]
include-tagged::{doc-tests-file}[{api}-response]
--------------------------------------------------
<1> The status of a specific action that was acked.
<2> The acknowledgement state of the action. If the action was successfully
acked, this state will be equal to `AckStatus.State.ACKED`.
[[java-rest-high-watcher-ack-watch-async]]
==== Asynchronous Execution
This request can be executed asynchronously:
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests}/WatcherDocumentationIT.java[ack-watch-execute-async]
--------------------------------------------------
<1> The `AckWatchRequest` to execute and the `ActionListener` to use when
the execution completes.
The asynchronous method does not block and returns immediately. Once the request
completes, the `ActionListener` is called back using the `onResponse` method
if the execution successfully completed or using the `onFailure` method if
it failed.
A listener for `AckWatchResponse` can be constructed as follows:
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests}/WatcherDocumentationIT.java[ack-watch-execute-listener]
--------------------------------------------------
<1> Called when the execution is successfully completed. The response is
provided as an argument.
<2> Called in case of failure. The raised exception is provided as an argument.
include::../execution.asciidoc[]