1Search::Elasticsearch::UCsleSireeanCrtoc:nh:t:7r:_iE0bl:ua:tsDetidircePsceetra:lr:cWDhao:tc:cuChmleeirne(tn3at)t:i:o7n_0::Direct::Watcher(3)
2
3
4

NAME

6       Search::Elasticsearch::Client::7_0::Direct::Watcher - Plugin providing
7       Watcher API for Search::Elasticsearch 7.x
8

VERSION

10       version 7.30
11

SYNOPSIS

13           my $response = $es->watcher->start();
14
15   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

METHODS

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
25   "put_watch()"
26           $response = $es->watcher->put_watch(
27               id    => $watch_id,     # required
28               body  => {...}
29           );
30
31       The "put_watch()" method is used to register a new watcher or to update
32       an existing watcher.
33
34       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
38       Query string parameters:
39           "active",
40           "error_trace",
41           "human",
42           "if_primary_term",
43           "if_seq_no",
44           "master_timeout",
45           "version"
46
47   "get_watch()"
48           $response = $es->watcher->get_watch(
49               id    => $watch_id,     # required
50           );
51
52       The "get_watch()" method is used to retrieve a watch by ID.
53
54       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
58       Query string parameters:
59           "error_trace",
60           "human"
61
62   "delete_watch()"
63           $response = $es->watcher->delete_watch(
64               id    => $watch_id,     # required
65           );
66
67       The "delete_watch()" method is used to delete a watch by ID.
68
69       Query string parameters:
70           "error_trace",
71           "force",
72           "human",
73           "master_timeout"
74
75       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
79   "execute_watch()"
80           $response = $es->watcher->execute_watch(
81               id    => $watch_id,     # optional
82               body  => {...}          # optional
83           );
84
85       The "execute_watch()" method forces the execution of a previously
86       registered watch.  Optional parameters may be passed in the "body".
87
88       Query string parameters:
89           "debug",
90           "error_trace",
91           "human"
92
93       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
97   "ack_watch()"
98           $response = $es->watcher->ack_watch(
99               watch_id => $watch_id,                  # required
100               action_id => $action_id | \@action_ids  # optional
101           );
102
103       The "ack_watch()" method is used to manually throttle the execution of
104       a watch.
105
106       Query string parameters:
107           "error_trace",
108           "human",
109           "master_timeout"
110
111       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
115   "activate_watch()"
116           $response = $es->watcher->activate_watch(
117               watch_id => $watch_id,                  # required
118           );
119
120       The "activate_watch()" method is used to activate a deactive watch.
121
122       Query string parameters:
123           "error_trace",
124           "human",
125           "master_timeout"
126
127       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
131   "deactivate_watch()"
132           $response = $es->watcher->deactivate_watch(
133               watch_id => $watch_id,                  # required
134           );
135
136       The "deactivate_watch()" method is used to deactivate an active watch.
137
138       Query string parameters:
139           "error_trace",
140           "human",
141           "master_timeout"
142
143       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
147   "stats()"
148           $response = $es->watcher->stats(
149               metric => $metric       # optional
150           );
151
152       The "stats()" method returns information about the status of the
153       watcher plugin.
154
155       See the stats docs
156       <https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-
157       api-stats.html> for more information.
158
159       Query string parameters:
160           "error_trace",
161           "human"
162
163   "stop()"
164           $response = $es->watcher->stop();
165
166       The "stop()" method stops the watcher service if it is running.
167
168       See the stop docs
169       <https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-
170       api-stop.html> for more information.
171
172       Query string parameters:
173           "error_trace",
174           "human"
175
176   "start()"
177           $response = $es->watcher->start();
178
179       The "start()" method starts the watcher service if it is not already
180       running.
181
182       See the start docs
183       <https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-
184       api-start.html> for more information.
185
186       Query string parameters:
187           "error_trace",
188           "human"
189
190   "restart()"
191           $response = $es->watcher->restart();
192
193       The "restart()" method stops then starts the watcher service.
194
195       See the restart docs
196       <https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-
197       api-restart.html> for more information.
198
199       Query string parameters:
200           "error_trace",
201           "human"
202

AUTHOR

204       Enrico Zimuel <enrico.zimuel@elastic.co>
205
207       This software is Copyright (c) 2020 by Elasticsearch BV.
208
209       This is free software, licensed under:
210
211         The Apache License, Version 2.0, January 2004
212
213
214
215perl v5.32.1            Search::El2a0s2t1i-c0s1e-a2r7ch::Client::7_0::Direct::Watcher(3)
Impressum