start-watch-service.asciidoc 1004 B

123456789101112131415161718192021222324252627282930313233
  1. --
  2. :api: start-watch-service
  3. :request: StartWatchServiceRequest
  4. :response: StartWatchServiceResponse
  5. --
  6. [id="{upid}-{api}"]
  7. === Start Watch Service API
  8. [id="{upid}-{api}-request"]
  9. ==== Execution
  10. {ref}/watcher-api-start.html[Start watcher] enables you
  11. to manually start the watch service. Submit the following request
  12. to start the watch service:
  13. ["source","java",subs="attributes,callouts,macros"]
  14. --------------------------------------------------
  15. include-tagged::{doc-tests-file}[{api}-request]
  16. --------------------------------------------------
  17. [id="{upid}-{api}-response"]
  18. ==== Response
  19. The returned `AcknowledgeResponse` contains a value on whether or not the request
  20. was received:
  21. ["source","java",subs="attributes,callouts,macros"]
  22. --------------------------------------------------
  23. include-tagged::{doc-tests-file}[{api}-response]
  24. --------------------------------------------------
  25. <1> A boolean value of `true` if successfully received, `false` otherwise.
  26. include::../execution.asciidoc[]