1
2
3[[Elasticsearch_Namespaces_IlmNamespace]]
4=== Elasticsearch\Namespaces\IlmNamespace
5
6
7
8Class IlmNamespace
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_IlmNamespacedeleteLifecycle_deleteLifecycle,`deleteLifecycle()`>>
22* <<Elasticsearch_Namespaces_IlmNamespaceexplainLifecycle_explainLifecycle,`explainLifecycle()`>>
23* <<Elasticsearch_Namespaces_IlmNamespacegetLifecycle_getLifecycle,`getLifecycle()`>>
24* <<Elasticsearch_Namespaces_IlmNamespacegetStatus_getStatus,`getStatus()`>>
25* <<Elasticsearch_Namespaces_IlmNamespacemoveToStep_moveToStep,`moveToStep()`>>
26* <<Elasticsearch_Namespaces_IlmNamespaceputLifecycle_putLifecycle,`putLifecycle()`>>
27* <<Elasticsearch_Namespaces_IlmNamespaceremovePolicy_removePolicy,`removePolicy()`>>
28* <<Elasticsearch_Namespaces_IlmNamespaceretry_retry,`retry()`>>
29* <<Elasticsearch_Namespaces_IlmNamespacestart_start,`start()`>>
30* <<Elasticsearch_Namespaces_IlmNamespacestop_stop,`stop()`>>
31
32
33
34[[Elasticsearch_Namespaces_IlmNamespacedeleteLifecycle_deleteLifecycle]]
35.`deleteLifecycle(array $params = [])`
36****
37[source,php]
38----
39/*
40$params['policy'] = (string) The name of the index lifecycle policy
41*/
42----
43****
44
45
46
47[[Elasticsearch_Namespaces_IlmNamespaceexplainLifecycle_explainLifecycle]]
48.`explainLifecycle(array $params = [])`
49****
50[source,php]
51----
52/*
53$params['index']        = (string) The name of the index to explain
54$params['only_managed'] = (boolean) filters the indices included in the response to ones managed by ILM
55$params['only_errors']  = (boolean) filters the indices included in the response to ones in an ILM error state, implies only_managed
56*/
57----
58****
59
60
61
62[[Elasticsearch_Namespaces_IlmNamespacegetLifecycle_getLifecycle]]
63.`getLifecycle(array $params = [])`
64****
65[source,php]
66----
67/*
68$params['policy'] = (string) The name of the index lifecycle policy
69*/
70----
71****
72
73
74
75[[Elasticsearch_Namespaces_IlmNamespacegetStatus_getStatus]]
76.`getStatus(array $params = [])`
77****
78[source,php]
79----
80/*
81*/
82----
83****
84
85
86
87[[Elasticsearch_Namespaces_IlmNamespacemoveToStep_moveToStep]]
88.`moveToStep(array $params = [])`
89****
90[source,php]
91----
92/*
93$params['index'] = (string) The name of the index whose lifecycle step is to change
94$params['body']  = (array) The new lifecycle step to move to
95*/
96----
97****
98
99
100
101[[Elasticsearch_Namespaces_IlmNamespaceputLifecycle_putLifecycle]]
102.`putLifecycle(array $params = [])`
103****
104[source,php]
105----
106/*
107$params['policy'] = (string) The name of the index lifecycle policy
108$params['body']   = (array) The lifecycle policy definition to register
109*/
110----
111****
112
113
114
115[[Elasticsearch_Namespaces_IlmNamespaceremovePolicy_removePolicy]]
116.`removePolicy(array $params = [])`
117****
118[source,php]
119----
120/*
121$params['index'] = (string) The name of the index to remove policy on
122*/
123----
124****
125
126
127
128[[Elasticsearch_Namespaces_IlmNamespaceretry_retry]]
129.`retry(array $params = [])`
130****
131[source,php]
132----
133/*
134$params['index'] = (string) The name of the indices (comma-separated) whose failed lifecycle step is to be retry
135*/
136----
137****
138
139
140
141[[Elasticsearch_Namespaces_IlmNamespacestart_start]]
142.`start(array $params = [])`
143****
144[source,php]
145----
146/*
147*/
148----
149****
150
151
152
153[[Elasticsearch_Namespaces_IlmNamespacestop_stop]]
154.`stop(array $params = [])`
155****
156[source,php]
157----
158/*
159*/
160----
161****
162
163
164