OpenSearch/docs/java-rest/high-level/watcher/start-watch-service.asciidoc

34 lines
1004 B
Plaintext

--
:api: start-watch-service
:request: StartWatchServiceRequest
:response: StartWatchServiceResponse
--
[id="{upid}-{api}"]
=== Start Watch Service API
[id="{upid}-{api}-request"]
==== Execution
{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[]