1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
|
# Licensed to Elasticsearch B.V. under one or more contributor
# license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright
# ownership. Elasticsearch B.V. licenses this file to you under
# the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
package Search::Elasticsearch::Client::8_0::Direct::Watcher;
$Search::Elasticsearch::Client::8_0::Direct::Watcher::VERSION = '8.12';
use Moo;
with 'Search::Elasticsearch::Client::8_0::Role::API';
with 'Search::Elasticsearch::Role::Client::Direct';
use namespace::clean;
__PACKAGE__->_install_api('watcher');
1;
=pod
=encoding UTF-8
=head1 NAME
Search::Elasticsearch::Client::8_0::Direct::Watcher - Plugin providing Watcher API for Search::Elasticsearch 8.x
=head1 VERSION
version 8.12
=head1 SYNOPSIS
my $response = $es->watcher->start();
=head2 DESCRIPTION
This class extends the L<Search::Elasticsearch> client with a C<watcher>
namespace, to support the
L<Watcher APIs|https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api.html>.
=head1 METHODS
The full documentation for the Watcher feature is available here:
L<https://www.elastic.co/guide/en/x-pack/current/xpack-alerting.html>
=head2 C<put_watch()>
$response = $es->watcher->put_watch(
id => $watch_id, # required
body => {...}
);
The C<put_watch()> method is used to register a new watcher or to update
an existing watcher.
See the L<put_watch docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-put-watch.html>
for more information.
Query string parameters:
C<active>,
C<error_trace>,
C<human>,
C<if_primary_term>,
C<if_seq_no>,
C<master_timeout>,
C<version>
=head2 C<get_watch()>
$response = $es->watcher->get_watch(
id => $watch_id, # required
);
The C<get_watch()> method is used to retrieve a watch by ID.
See the L<get_watch docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-get-watch.html>
for more information.
Query string parameters:
C<error_trace>,
C<human>
=head2 C<delete_watch()>
$response = $es->watcher->delete_watch(
id => $watch_id, # required
);
The C<delete_watch()> method is used to delete a watch by ID.
Query string parameters:
C<error_trace>,
C<force>,
C<human>,
C<master_timeout>
See the L<delete_watch docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-delete-watch.html>
for more information.
=head2 C<execute_watch()>
$response = $es->watcher->execute_watch(
id => $watch_id, # optional
body => {...} # optional
);
The C<execute_watch()> method forces the execution of a previously
registered watch. Optional parameters may be passed in the C<body>.
Query string parameters:
C<debug>,
C<error_trace>,
C<human>
See the L<execute_watch docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-execute-watch.html>
for more information.
=head2 C<ack_watch()>
$response = $es->watcher->ack_watch(
watch_id => $watch_id, # required
action_id => $action_id | \@action_ids # optional
);
The C<ack_watch()> method is used to manually throttle the execution of
a watch.
Query string parameters:
C<error_trace>,
C<human>,
C<master_timeout>
See the L<ack_watch docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-ack-watch.html>
for more information.
=head2 C<activate_watch()>
$response = $es->watcher->activate_watch(
watch_id => $watch_id, # required
);
The C<activate_watch()> method is used to activate a deactive watch.
Query string parameters:
C<error_trace>,
C<human>,
C<master_timeout>
See the L<activate_watch docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-activate-watch.html>
for more information.
=head2 C<deactivate_watch()>
$response = $es->watcher->deactivate_watch(
watch_id => $watch_id, # required
);
The C<deactivate_watch()> method is used to deactivate an active watch.
Query string parameters:
C<error_trace>,
C<human>,
C<master_timeout>
See the L<deactivate_watch docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-deactivate-watch.html>
for more information.
=head2 C<stats()>
$response = $es->watcher->stats(
metric => $metric # optional
);
The C<stats()> method returns information about the status of the watcher plugin.
See the L<stats docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stats.html>
for more information.
Query string parameters:
C<error_trace>,
C<human>
=head2 C<stop()>
$response = $es->watcher->stop();
The C<stop()> method stops the watcher service if it is running.
See the L<stop docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stop.html>
for more information.
Query string parameters:
C<error_trace>,
C<human>
=head2 C<start()>
$response = $es->watcher->start();
The C<start()> method starts the watcher service if it is not already running.
See the L<start docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-start.html>
for more information.
Query string parameters:
C<error_trace>,
C<human>
=head2 C<restart()>
$response = $es->watcher->restart();
The C<restart()> method stops then starts the watcher service.
See the L<restart docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-restart.html>
for more information.
Query string parameters:
C<error_trace>,
C<human>
=head1 AUTHOR
Enrico Zimuel <enrico.zimuel@elastic.co>
=head1 COPYRIGHT AND LICENSE
This software is Copyright (c) 2024 by Elasticsearch BV.
This is free software, licensed under:
The Apache License, Version 2.0, January 2004
=cut
__END__
# ABSTRACT: Plugin providing Watcher API for Search::Elasticsearch 8.x
|
