1Search::Elasticsearch::UCsleirenCtoS:ne:ta7rr_ic0bh:u::t:DeEidlraePscettri:lc:sIDeLoaMcr(uc3mh)e:n:tCaltiieonnt::7_0::Direct::ILM(3)
2
3
4

NAME

6       Search::Elasticsearch::Client::7_0::Direct::ILM - Plugin providing
7       index lifecycle management APIs for Search::Elasticsearch 7.x
8

VERSION

10       version 7.717
11
12   DESCRIPTION
13       This module provides methods to use the index lifecycle management
14       feature.
15
16       The full documentation for ILM is available here:
17       <https://www.elastic.co/guide/en/elasticsearch/reference/current/index-lifecycle-management.html>
18

POLICY METHODS

20   "put_lifecycle()"
21           $response = $es->ilm->put_lifecycle(
22               policy  => $policy  # required
23               body    => {...}    # required
24           )
25
26       The "put_lifecycle()" method creates or updates a lifecycle policy.
27
28       Query string parameters:
29           "error_trace",
30           "filter_path",
31           "human"
32
33       See the ILM put_lifecycle docs
34       <https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-
35       put-lifecycle.html> for more information.
36
37   "put_lifecycle()"
38           $response = $es->ilm->put_lifecycle(
39               policy  => $policy  # required
40               body    => {...}    # required
41           )
42
43       The "put_lifecycle()" method creates or updates a lifecycle policy.
44
45       Query string parameters:
46           "error_trace",
47           "filter_path",
48           "human"
49
50       See the ILM put_lifecycle docs
51       <https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-
52       put-lifecycle.html> for more information.
53
54   "get_lifecycle()"
55           $response = $es->ilm->get_lifecycle(
56               policy  => $policy  # required
57           )
58
59       The "get_lifecycle()" method retrieves the specified policy
60
61       Query string parameters:
62           "error_trace",
63           "filter_path",
64           "human"
65
66       See the ILM get_lifecycle docs
67       <https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-
68       get-lifecycle.html> for more information.
69
70   "delete_lifecycle()"
71           $response = $es->ilm->delete_lifecycle(
72               policy  => $policy  # required
73           )
74
75       The "delete_lifecycle()" method deletes the specified policy
76
77       Query string parameters:
78           "error_trace",
79           "filter_path",
80           "human"
81
82       See the ILM delete_lifecycle docs
83       <https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-
84       remove-lifecycle.html> for more information.
85

INDEX MANAGEMENT METHODS

87   "move_to_step()"
88           $response = $es->ilm->move_to_step(
89               index  => $index,       # required
90               body   => {...}         # required
91           )
92
93       The "move_to_step()" method triggers execution of a specific step in
94       the lifecycle policy.
95
96       Query string parameters:
97           "error_trace",
98           "filter_path",
99           "human"
100
101       See the ILM move_to_step docs
102       <https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-
103       move-to-step.html> for more information.
104
105   "retry()"
106           $response = $es->ilm->retry(
107               index  => $index,       # required
108           )
109
110       The "retry()" method retries executing the policy for an index that is
111       in the ERROR step.
112
113       Query string parameters:
114           "error_trace",
115           "filter_path",
116           "human"
117
118       See the ILM retry docs
119       <https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-
120       retry.html> for more information.
121
122   "remove_lifecycle()"
123           $response = $es->ilm->remove_lifecycle(
124               index  => $index  # required
125           )
126
127       The "remove_lifecycle()" method removes a lifecycle from the specified
128       index.
129
130       Query string parameters:
131           "error_trace",
132           "filter_path",
133           "human"
134
135       See the ILM remove_lifecycle docs
136       <https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-
137       remove-lifecycle.html> for more information.
138
139   "explain_lifecycle()"
140           $response = $es->ilm->explain_lifecycle(
141               index  => $index  # required
142           )
143
144       The "explain_lifecycle()" method returns information about the index’s
145       current lifecycle state.
146
147       Query string parameters:
148           "error_trace",
149           "filter_path",
150           "human"
151
152       See the ILM explain_lifecycle docs
153       <https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-
154       explain-lifecycle.html> for more information.
155

OPERATION MANAGEMENT APIS

157   "status()"
158           $response = $es->ilm->status;
159
160       The "status()" method returns the current operating mode for ILM.
161
162       Query string parameters:
163           "error_trace",
164           "filter_path",
165           "human"
166
167       See the ILM status docs
168       <https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-
169       get-status.html> for more information.
170
171   "start()"
172           $response = $es->ilm->start;
173
174       The "start()" method starts the index lifecycle management process.
175
176       Query string parameters:
177           "error_trace",
178           "filter_path",
179           "human"
180
181       See the ILM start docs
182       <https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-
183       start.html> for more information.
184
185   "stop()"
186           $response = $es->ilm->stop;
187
188       The "stop()" method stops the index lifecycle management process.
189
190       Query string parameters:
191           "error_trace",
192           "filter_path",
193           "human"
194
195       See the ILM stop docs
196       <https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-
197       stop.html> for more information.
198

AUTHOR

200       Enrico Zimuel <enrico.zimuel@elastic.co>
201

203       This software is Copyright (c) 2022 by Elasticsearch BV.
204
205       This is free software, licensed under:
206
207         The Apache License, Version 2.0, January 2004
208
209
210
211perl v5.36.0                Search2:0:2E2l-a0s7t-i3c1search::Client::7_0::Direct::ILM(3)
Impressum