mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-20 03:45:02 +00:00
[DOCS] Synchs Watcher API titles with better HLRC titles (#46328)
This commit is contained in:
parent
da5618cbf4
commit
b11968cf4d
@ -5,12 +5,12 @@
|
|||||||
--
|
--
|
||||||
|
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Ack Watch API
|
=== Ack watch API
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[id="{upid}-{api}-request"]
|
||||||
==== Execution
|
==== Execution
|
||||||
|
|
||||||
{xpack-ref}/actions.html#actions-ack-throttle[Acknowledging a watch] enables you
|
{stack-ov}/actions.html#actions-ack-throttle[Acknowledging a watch] enables you
|
||||||
to manually throttle execution of a watch's actions. A watch can be acknowledged
|
to manually throttle execution of a watch's actions. A watch can be acknowledged
|
||||||
through the following request:
|
through the following request:
|
||||||
|
|
||||||
|
@ -5,7 +5,7 @@
|
|||||||
--
|
--
|
||||||
|
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Activate Watch API
|
=== Activate watch API
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[id="{upid}-{api}-request"]
|
||||||
==== Execution
|
==== Execution
|
||||||
@ -29,7 +29,7 @@ include-tagged::{doc-tests-file}[{api}-response]
|
|||||||
<1> `watchStatus` contains status of the watch
|
<1> `watchStatus` contains status of the watch
|
||||||
|
|
||||||
[id="{upid}-{api}-request-async"]
|
[id="{upid}-{api}-request-async"]
|
||||||
==== Asynchronous Execution
|
==== Asynchronous execution
|
||||||
|
|
||||||
This request can be executed asynchronously:
|
This request can be executed asynchronously:
|
||||||
|
|
||||||
|
@ -5,6 +5,6 @@
|
|||||||
:doc-tests-file: {doc-tests}/WatcherDocumentationIT.java
|
:doc-tests-file: {doc-tests}/WatcherDocumentationIT.java
|
||||||
--
|
--
|
||||||
[[java-rest-high-watcher-deactivate-watch]]
|
[[java-rest-high-watcher-deactivate-watch]]
|
||||||
=== Deactivate Watch API
|
=== Deactivate watch API
|
||||||
|
|
||||||
include::../execution.asciidoc[]
|
include::../execution.asciidoc[]
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
[[java-rest-high-x-pack-watcher-delete-watch]]
|
[[java-rest-high-x-pack-watcher-delete-watch]]
|
||||||
=== Delete Watch API
|
=== Delete watch API
|
||||||
|
|
||||||
[[java-rest-high-x-pack-watcher-delete-watch-execution]]
|
[[java-rest-high-x-pack-watcher-delete-watch-execution]]
|
||||||
==== Execution
|
==== Execution
|
||||||
@ -26,7 +26,7 @@ include-tagged::{doc-tests}/WatcherDocumentationIT.java[x-pack-put-watch-respons
|
|||||||
<3> `_version` returns the version of the deleted watch
|
<3> `_version` returns the version of the deleted watch
|
||||||
|
|
||||||
[[java-rest-high-x-pack-watcher-delete-watch-async]]
|
[[java-rest-high-x-pack-watcher-delete-watch-async]]
|
||||||
==== Asynchronous Execution
|
==== Asynchronous execution
|
||||||
|
|
||||||
This request can be executed asynchronously:
|
This request can be executed asynchronously:
|
||||||
|
|
||||||
|
@ -4,7 +4,7 @@
|
|||||||
:response: ExecuteWatchResponse
|
:response: ExecuteWatchResponse
|
||||||
--
|
--
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Execute Watch API
|
=== Execute watch API
|
||||||
|
|
||||||
The execute watch API allows clients to immediately execute a watch, either
|
The execute watch API allows clients to immediately execute a watch, either
|
||||||
one that has been previously added via the
|
one that has been previously added via the
|
||||||
@ -27,7 +27,7 @@ include-tagged::{doc-tests-file}[x-pack-execute-watch-by-id]
|
|||||||
<6> Enable debug mode
|
<6> Enable debug mode
|
||||||
|
|
||||||
[id="{upid}-{api}-response-by-id"]
|
[id="{upid}-{api}-response-by-id"]
|
||||||
==== Execute by id Response
|
==== Execute by id response
|
||||||
|
|
||||||
The returned `Response` contains details of the execution:
|
The returned `Response` contains details of the execution:
|
||||||
|
|
||||||
|
@ -5,7 +5,7 @@
|
|||||||
--
|
--
|
||||||
|
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Get Watch API
|
=== Get watch API
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[id="{upid}-{api}-request"]
|
||||||
==== Execution
|
==== Execution
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
[[java-rest-high-x-pack-watcher-put-watch]]
|
[[java-rest-high-x-pack-watcher-put-watch]]
|
||||||
=== Put Watch API
|
=== Put watch API
|
||||||
|
|
||||||
[[java-rest-high-x-pack-watcher-put-watch-execution]]
|
[[java-rest-high-x-pack-watcher-put-watch-execution]]
|
||||||
==== Execution
|
==== Execution
|
||||||
@ -28,7 +28,7 @@ include-tagged::{doc-tests}/WatcherDocumentationIT.java[x-pack-put-watch-respons
|
|||||||
<3> `_version` returns the newly created version
|
<3> `_version` returns the newly created version
|
||||||
|
|
||||||
[[java-rest-high-x-pack-watcher-put-watch-async]]
|
[[java-rest-high-x-pack-watcher-put-watch-async]]
|
||||||
==== Asynchronous Execution
|
==== Asynchronous execution
|
||||||
|
|
||||||
This request can be executed asynchronously:
|
This request can be executed asynchronously:
|
||||||
|
|
||||||
|
@ -4,7 +4,7 @@
|
|||||||
:response: StartWatchServiceResponse
|
:response: StartWatchServiceResponse
|
||||||
--
|
--
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Start Watch Service API
|
=== Start watch service API
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[id="{upid}-{api}-request"]
|
||||||
==== Execution
|
==== Execution
|
||||||
|
@ -4,7 +4,7 @@
|
|||||||
:response: StopWatchServiceResponse
|
:response: StopWatchServiceResponse
|
||||||
--
|
--
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Stop Watch Service API
|
=== Stop watch service API
|
||||||
|
|
||||||
[[java-rest-high-watcher-stop-watch-service-execution]]
|
[[java-rest-high-watcher-stop-watch-service-execution]]
|
||||||
==== Execution
|
==== Execution
|
||||||
|
@ -4,7 +4,7 @@
|
|||||||
:response: WatcherStatsResponse
|
:response: WatcherStatsResponse
|
||||||
--
|
--
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Watcher Stats API
|
=== Get Watcher stats API
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[id="{upid}-{api}-request"]
|
||||||
==== Execution
|
==== Execution
|
||||||
|
@ -13,13 +13,22 @@
|
|||||||
* <<watcher-api-stop>>
|
* <<watcher-api-stop>>
|
||||||
* <<watcher-api-start>>
|
* <<watcher-api-start>>
|
||||||
|
|
||||||
include::watcher/put-watch.asciidoc[]
|
//ACK
|
||||||
include::watcher/get-watch.asciidoc[]
|
|
||||||
include::watcher/delete-watch.asciidoc[]
|
|
||||||
include::watcher/execute-watch.asciidoc[]
|
|
||||||
include::watcher/ack-watch.asciidoc[]
|
include::watcher/ack-watch.asciidoc[]
|
||||||
|
//ACTIVATE
|
||||||
include::watcher/activate-watch.asciidoc[]
|
include::watcher/activate-watch.asciidoc[]
|
||||||
|
//DEACTIVATE
|
||||||
include::watcher/deactivate-watch.asciidoc[]
|
include::watcher/deactivate-watch.asciidoc[]
|
||||||
|
//DELETE
|
||||||
|
include::watcher/delete-watch.asciidoc[]
|
||||||
|
//EXECUTE
|
||||||
|
include::watcher/execute-watch.asciidoc[]
|
||||||
|
//GET
|
||||||
|
include::watcher/get-watch.asciidoc[]
|
||||||
include::watcher/stats.asciidoc[]
|
include::watcher/stats.asciidoc[]
|
||||||
include::watcher/stop.asciidoc[]
|
//PUT
|
||||||
|
include::watcher/put-watch.asciidoc[]
|
||||||
|
//START
|
||||||
include::watcher/start.asciidoc[]
|
include::watcher/start.asciidoc[]
|
||||||
|
//STOP
|
||||||
|
include::watcher/stop.asciidoc[]
|
@ -1,12 +1,11 @@
|
|||||||
[role="xpack"]
|
[role="xpack"]
|
||||||
[[watcher-api-start]]
|
[[watcher-api-start]]
|
||||||
=== Start API
|
=== Start watch service API
|
||||||
++++
|
++++
|
||||||
<titleabbrev>Start</titleabbrev>
|
<titleabbrev>Start watch service</titleabbrev>
|
||||||
++++
|
++++
|
||||||
|
|
||||||
The `start` API starts the {watcher} service if the service is not already
|
Starts the {watcher} service if it is not already running.
|
||||||
running.
|
|
||||||
|
|
||||||
[float]
|
[float]
|
||||||
==== Request
|
==== Request
|
||||||
|
@ -1,11 +1,12 @@
|
|||||||
[role="xpack"]
|
[role="xpack"]
|
||||||
[[watcher-api-stats]]
|
[[watcher-api-stats]]
|
||||||
=== Stats API
|
=== Get {watcher} stats API
|
||||||
|
[subs="attributes"]
|
||||||
++++
|
++++
|
||||||
<titleabbrev>Stats</titleabbrev>
|
<titleabbrev>Get {watcher} stats</titleabbrev>
|
||||||
++++
|
++++
|
||||||
|
|
||||||
The `stats` API returns the current {watcher} metrics.
|
Retrieves the current {watcher} metrics.
|
||||||
|
|
||||||
[float]
|
[float]
|
||||||
==== Request
|
==== Request
|
||||||
|
@ -1,11 +1,11 @@
|
|||||||
[role="xpack"]
|
[role="xpack"]
|
||||||
[[watcher-api-stop]]
|
[[watcher-api-stop]]
|
||||||
=== Stop API
|
=== Stop watch service API
|
||||||
++++
|
++++
|
||||||
<titleabbrev>Stop</titleabbrev>
|
<titleabbrev>Stop watch service</titleabbrev>
|
||||||
++++
|
++++
|
||||||
|
|
||||||
The `stop` API stops the {watcher} service if the service is running.
|
Stops the {watcher} service if it is running.
|
||||||
|
|
||||||
[float]
|
[float]
|
||||||
==== Request
|
==== Request
|
||||||
|
Loading…
x
Reference in New Issue
Block a user