1Search::Elasticsearch::UCsleSireeanCrtoc:nh:t:7r:_iE0bl:ua:tsDetidircePsceetra:lr:cWDhao:tc:cuChmleeirne(tn3at)t:i:o7n_0::Direct::Watcher(3)
2
6 Search::Elasticsearch::Client::7_0::Direct::Watcher - Plugin providing
7 Watcher API for Search::Elasticsearch 7.x
8
10 version 7.715
11
13 my $response = $es->watcher->start();
14 DESCRIPTION
16 This class extends the Search::Elasticsearch client with a "watcher"
17 namespace, to support the Watcher APIs
18 <https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-
19 api.html>.
20
22 The full documentation for the Watcher feature is available here:
23 <https://www.elastic.co/guide/en/x-pack/current/xpack-alerting.html>
24 "put_watch()"
26 $response = $es->watcher->put_watch(
27 id => $watch_id, # required
28 body => {...}
29 );
30 The "put_watch()" method is used to register a new watcher or to update
32 an existing watcher.
33 See the put_watch docs
35 <https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-
36 api-put-watch.html> for more information.
37 Query string parameters:
39 "active",
40 "error_trace",
41 "human",
42 "if_primary_term",
43 "if_seq_no",
44 "master_timeout",
45 "version"
46 "get_watch()"
48 $response = $es->watcher->get_watch(
49 id => $watch_id, # required
50 );
51 The "get_watch()" method is used to retrieve a watch by ID.
53 See the get_watch docs
55 <https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-
56 api-get-watch.html> for more information.
57 Query string parameters:
59 "error_trace",
60 "human"
61 "delete_watch()"
63 $response = $es->watcher->delete_watch(
64 id => $watch_id, # required
65 );
66 The "delete_watch()" method is used to delete a watch by ID.
68 Query string parameters:
70 "error_trace",
71 "force",
72 "human",
73 "master_timeout"
74 See the delete_watch docs
76 <https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-
77 api-delete-watch.html> for more information.
78 "execute_watch()"
80 $response = $es->watcher->execute_watch(
81 id => $watch_id, # optional
82 body => {...} # optional
83 );
84 The "execute_watch()" method forces the execution of a previously
86 registered watch. Optional parameters may be passed in the "body".
87 Query string parameters:
89 "debug",
90 "error_trace",
91 "human"
92 See the execute_watch docs
94 <https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-
95 api-execute-watch.html> for more information.
96 "ack_watch()"
98 $response = $es->watcher->ack_watch(
99 watch_id => $watch_id, # required
100 action_id => $action_id | \@action_ids # optional
101 );
102 The "ack_watch()" method is used to manually throttle the execution of
104 a watch.
105 Query string parameters:
107 "error_trace",
108 "human",
109 "master_timeout"
110 See the ack_watch docs
112 <https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-
113 api-ack-watch.html> for more information.
114 "activate_watch()"
116 $response = $es->watcher->activate_watch(
117 watch_id => $watch_id, # required
118 );
119 The "activate_watch()" method is used to activate a deactive watch.
121 Query string parameters:
123 "error_trace",
124 "human",
125 "master_timeout"
126 See the activate_watch docs
128 <https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-
129 api-activate-watch.html> for more information.
130 "deactivate_watch()"
132 $response = $es->watcher->deactivate_watch(
133 watch_id => $watch_id, # required
134 );
135 The "deactivate_watch()" method is used to deactivate an active watch.
137 Query string parameters:
139 "error_trace",
140 "human",
141 "master_timeout"
142 See the deactivate_watch docs
144 <https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-
145 api-deactivate-watch.html> for more information.
146 "stats()"
148 $response = $es->watcher->stats(
149 metric => $metric # optional
150 );
151 The "stats()" method returns information about the status of the
153 watcher plugin.
154 See the stats docs
156 <https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-
157 api-stats.html> for more information.
158 Query string parameters:
160 "error_trace",
161 "human"
162 "stop()"
164 $response = $es->watcher->stop();
165 The "stop()" method stops the watcher service if it is running.
167 See the stop docs
169 <https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-
170 api-stop.html> for more information.
171 Query string parameters:
173 "error_trace",
174 "human"
175 "start()"
177 $response = $es->watcher->start();
178 The "start()" method starts the watcher service if it is not already
180 running.
181 See the start docs
183 <https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-
184 api-start.html> for more information.
185 Query string parameters:
187 "error_trace",
188 "human"
189 "restart()"
191 $response = $es->watcher->restart();
192 The "restart()" method stops then starts the watcher service.
194 See the restart docs
196 <https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-
197 api-restart.html> for more information.
198 Query string parameters:
200 "error_trace",
201 "human"
202
204 Enrico Zimuel <enrico.zimuel@elastic.co>
205
207 This software is Copyright (c) 2021 by Elasticsearch BV.
208 This is free software, licensed under:
210 The Apache License, Version 2.0, January 2004
212perl v5.34.0 Search::El2a0s2t2i-c0s1e-a2r1ch::Client::7_0::Direct::Watcher(3)