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

[HLRC] Add Start/Stop Watch Service APIs. (#34317)

Browse source
This commit is contained in:
Jack Conradson 2018-10-19 09:42:57 -07:00 • committed by GitHub
parent 90ca5b1fde
commit 1100942455
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
10 changed files with 322 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -335,11 +335,15 @@ include::security/delete-role-mapping.asciidoc[]
The Java High Level REST Client supports the following Watcher APIs:
* <<java-rest-high-watcher-start-watch-service>>
* <<java-rest-high-watcher-stop-watch-service>>
* <<java-rest-high-x-pack-watcher-put-watch>>
* <<java-rest-high-x-pack-watcher-delete-watch>>
* <<{upid}-ack-watch>>
* <<{upid}-activate-watch>>
include::watcher/start-watch-service.asciidoc[]
include::watcher/stop-watch-service.asciidoc[]
include::watcher/put-watch.asciidoc[]
include::watcher/delete-watch.asciidoc[]
include::watcher/ack-watch.asciidoc[]

33
docs/java-rest/high-level/watcher/start-watch-service.asciidoc Normal file
View file

@ -0,0 +1,33 @@
--
:api: start-watch-service
:request: StartWatchServiceRequest
:response: StartWatchServiceResponse
--
[id="{upid}-{api}"]
=== Start Watch Service API
[id="{upid}-{api}-request"]
==== Execution
{xpack-ref}/watcher-api-start.html[Start watcher] enables you
to manually start the watch service. Submit the following request
to start the watch service:
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-request]
--------------------------------------------------
[id="{upid}-{api}-response"]
==== Response
The returned `AcknowledgeResponse` contains a value on whether or not the request
was received:
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-response]
--------------------------------------------------
<1> A boolean value of `true` if successfully received, `false` otherwise.
include::../execution.asciidoc[]

33
docs/java-rest/high-level/watcher/stop-watch-service.asciidoc Normal file
View file

@ -0,0 +1,33 @@
--
:api: stop-watch-service
:request: StopWatchServiceRequest
:response: StopWatchServiceResponse
--
[id="{upid}-{api}"]
=== Stop Watch Service API
[[java-rest-high-watcher-stop-watch-service-execution]]
==== Execution
{xpack-ref}/watcher-api-stop.html[Stop watcher] enables you
to manually stop the watch service. Submit the following request
to stop the watch service:
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-request]
--------------------------------------------------
[[java-rest-high-watcher-stop-watch-service-response]]
==== Response
The returned `AcknowledgeResponse` contains a value on whether or not the request
was received:
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-response]
--------------------------------------------------
<1> A boolean value of `true` if successfully received, `false` otherwise.
include::../execution.asciidoc[]