1
2
3[[Elasticsearch_Namespaces_WatcherNamespace]]
4=== Elasticsearch\Namespaces\WatcherNamespace
5
6
7
8Class WatcherNamespace
9
10*Description*
11
12
13NOTE: this file is autogenerated using util/GenerateEndpoints.php
14and Elasticsearch 7.12.1 (3186837139b9c6b6d23c3200870651f10d3343b7)
15
16
17*Methods*
18
19The class defines the following methods:
20
21* <<Elasticsearch_Namespaces_WatcherNamespaceackWatch_ackWatch,`ackWatch()`>>
22* <<Elasticsearch_Namespaces_WatcherNamespaceactivateWatch_activateWatch,`activateWatch()`>>
23* <<Elasticsearch_Namespaces_WatcherNamespacedeactivateWatch_deactivateWatch,`deactivateWatch()`>>
24* <<Elasticsearch_Namespaces_WatcherNamespacedeleteWatch_deleteWatch,`deleteWatch()`>>
25* <<Elasticsearch_Namespaces_WatcherNamespaceexecuteWatch_executeWatch,`executeWatch()`>>
26* <<Elasticsearch_Namespaces_WatcherNamespacegetWatch_getWatch,`getWatch()`>>
27* <<Elasticsearch_Namespaces_WatcherNamespaceputWatch_putWatch,`putWatch()`>>
28* <<Elasticsearch_Namespaces_WatcherNamespacequeryWatches_queryWatches,`queryWatches()`>>
29* <<Elasticsearch_Namespaces_WatcherNamespacestart_start,`start()`>>
30* <<Elasticsearch_Namespaces_WatcherNamespacestats_stats,`stats()`>>
31* <<Elasticsearch_Namespaces_WatcherNamespacestop_stop,`stop()`>>
32
33
34
35[[Elasticsearch_Namespaces_WatcherNamespaceackWatch_ackWatch]]
36.`ackWatch(array $params = [])`
37****
38[source,php]
39----
40/*
41$params['watch_id']  = (string) Watch ID (Required)
42$params['action_id'] = (list) A comma-separated list of the action ids to be acked
43*/
44----
45****
46
47
48
49[[Elasticsearch_Namespaces_WatcherNamespaceactivateWatch_activateWatch]]
50.`activateWatch(array $params = [])`
51****
52[source,php]
53----
54/*
55$params['watch_id'] = (string) Watch ID
56*/
57----
58****
59
60
61
62[[Elasticsearch_Namespaces_WatcherNamespacedeactivateWatch_deactivateWatch]]
63.`deactivateWatch(array $params = [])`
64****
65[source,php]
66----
67/*
68$params['watch_id'] = (string) Watch ID
69*/
70----
71****
72
73
74
75[[Elasticsearch_Namespaces_WatcherNamespacedeleteWatch_deleteWatch]]
76.`deleteWatch(array $params = [])`
77****
78[source,php]
79----
80/*
81$params['id'] = (string) Watch ID
82*/
83----
84****
85
86
87
88[[Elasticsearch_Namespaces_WatcherNamespaceexecuteWatch_executeWatch]]
89.`executeWatch(array $params = [])`
90****
91[source,php]
92----
93/*
94$params['id']    = (string) Watch ID
95$params['debug'] = (boolean) indicates whether the watch should execute in debug mode
96$params['body']  = (array) Execution control
97*/
98----
99****
100
101
102
103[[Elasticsearch_Namespaces_WatcherNamespacegetWatch_getWatch]]
104.`getWatch(array $params = [])`
105****
106[source,php]
107----
108/*
109$params['id'] = (string) Watch ID
110*/
111----
112****
113
114
115
116[[Elasticsearch_Namespaces_WatcherNamespaceputWatch_putWatch]]
117.`putWatch(array $params = [])`
118****
119[source,php]
120----
121/*
122$params['id']              = (string) Watch ID
123$params['active']          = (boolean) Specify whether the watch is in/active by default
124$params['version']         = (number) Explicit version number for concurrency control
125$params['if_seq_no']       = (number) only update the watch if the last operation that has changed the watch has the specified sequence number
126$params['if_primary_term'] = (number) only update the watch if the last operation that has changed the watch has the specified primary term
127$params['body']            = (array) The watch
128*/
129----
130****
131
132
133
134[[Elasticsearch_Namespaces_WatcherNamespacequeryWatches_queryWatches]]
135.`queryWatches(array $params = [])`
136****
137[source,php]
138----
139/*
140$params['body'] = (array) From, size, query, sort and search_after
141*/
142----
143****
144
145
146
147[[Elasticsearch_Namespaces_WatcherNamespacestart_start]]
148.`start(array $params = [])`
149****
150[source,php]
151----
152/*
153*/
154----
155****
156
157
158
159[[Elasticsearch_Namespaces_WatcherNamespacestats_stats]]
160.`stats(array $params = [])`
161****
162[source,php]
163----
164/*
165$params['metric']           = (list) Controls what additional stat metrics should be include in the response
166$params['emit_stacktraces'] = (boolean) Emits stack traces of currently running watches
167*/
168----
169****
170
171
172
173[[Elasticsearch_Namespaces_WatcherNamespacestop_stop]]
174.`stop(array $params = [])`
175****
176[source,php]
177----
178/*
179*/
180----
181****
182
183
184