| 1 |
# Licensed to Elasticsearch B.V. under one or more contributor |
| 2 |
# license agreements. See the NOTICE file distributed with |
| 3 |
# this work for additional information regarding copyright |
| 4 |
# ownership. Elasticsearch B.V. licenses this file to you under |
| 5 |
# the Apache License, Version 2.0 (the "License"); you may |
| 6 |
# not use this file except in compliance with the License. |
| 7 |
# You may obtain a copy of the License at |
| 8 |
# |
| 9 |
# http://www.apache.org/licenses/LICENSE-2.0 |
| 10 |
# |
| 11 |
# Unless required by applicable law or agreed to in writing, |
| 12 |
# software distributed under the License is distributed on an |
| 13 |
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| 14 |
# KIND, either express or implied. See the License for the |
| 15 |
# specific language governing permissions and limitations |
| 16 |
# under the License. |
| 17 |
|
| 18 |
package Search::Elasticsearch::Client::8_0::Direct::ILM; |
| 19 |
$Search::Elasticsearch::Client::8_0::Direct::ILM::VERSION = '8.12'; |
| 20 |
use Moo; |
| 21 |
with 'Search::Elasticsearch::Client::8_0::Role::API'; |
| 22 |
with 'Search::Elasticsearch::Role::Client::Direct'; |
| 23 |
use Search::Elasticsearch::Util qw(parse_params); |
| 24 |
use namespace::clean; |
| 25 |
__PACKAGE__->_install_api('ilm'); |
| 26 |
|
| 27 |
1; |
| 28 |
|
| 29 |
=pod |
| 30 |
|
| 31 |
=encoding UTF-8 |
| 32 |
|
| 33 |
=head1 NAME |
| 34 |
|
| 35 |
Search::Elasticsearch::Client::8_0::Direct::ILM - Plugin providing index lifecycle management APIs for Search::Elasticsearch 8.x |
| 36 |
|
| 37 |
=head1 VERSION |
| 38 |
|
| 39 |
version 8.12 |
| 40 |
|
| 41 |
=head2 DESCRIPTION |
| 42 |
|
| 43 |
This module provides methods to use the index lifecycle management feature. |
| 44 |
|
| 45 |
The full documentation for ILM is available here: |
| 46 |
L<https://www.elastic.co/guide/en/elasticsearch/reference/current/index-lifecycle-management.html> |
| 47 |
|
| 48 |
=head1 POLICY METHODS |
| 49 |
|
| 50 |
=head2 C<put_lifecycle()> |
| 51 |
|
| 52 |
$response = $es->ilm->put_lifecycle( |
| 53 |
policy => $policy # required |
| 54 |
body => {...} # required |
| 55 |
) |
| 56 |
|
| 57 |
The C<put_lifecycle()> method creates or updates a lifecycle policy. |
| 58 |
|
| 59 |
Query string parameters: |
| 60 |
C<error_trace>, |
| 61 |
C<filter_path>, |
| 62 |
C<human> |
| 63 |
|
| 64 |
See the L<ILM put_lifecycle docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-put-lifecycle.html> |
| 65 |
for more information. |
| 66 |
|
| 67 |
=head2 C<put_lifecycle()> |
| 68 |
|
| 69 |
$response = $es->ilm->put_lifecycle( |
| 70 |
policy => $policy # required |
| 71 |
body => {...} # required |
| 72 |
) |
| 73 |
|
| 74 |
The C<put_lifecycle()> method creates or updates a lifecycle policy. |
| 75 |
|
| 76 |
Query string parameters: |
| 77 |
C<error_trace>, |
| 78 |
C<filter_path>, |
| 79 |
C<human> |
| 80 |
|
| 81 |
See the L<ILM put_lifecycle docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-put-lifecycle.html> |
| 82 |
for more information. |
| 83 |
|
| 84 |
=head2 C<get_lifecycle()> |
| 85 |
|
| 86 |
$response = $es->ilm->get_lifecycle( |
| 87 |
policy => $policy # required |
| 88 |
) |
| 89 |
|
| 90 |
The C<get_lifecycle()> method retrieves the specified policy |
| 91 |
|
| 92 |
Query string parameters: |
| 93 |
C<error_trace>, |
| 94 |
C<filter_path>, |
| 95 |
C<human> |
| 96 |
|
| 97 |
See the L<ILM get_lifecycle docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-lifecycle.html> |
| 98 |
for more information. |
| 99 |
|
| 100 |
=head2 C<delete_lifecycle()> |
| 101 |
|
| 102 |
$response = $es->ilm->delete_lifecycle( |
| 103 |
policy => $policy # required |
| 104 |
) |
| 105 |
|
| 106 |
The C<delete_lifecycle()> method deletes the specified policy |
| 107 |
|
| 108 |
Query string parameters: |
| 109 |
C<error_trace>, |
| 110 |
C<filter_path>, |
| 111 |
C<human> |
| 112 |
|
| 113 |
See the L<ILM delete_lifecycle docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-remove-lifecycle.html> |
| 114 |
for more information. |
| 115 |
|
| 116 |
=head1 INDEX MANAGEMENT METHODS |
| 117 |
|
| 118 |
=head2 C<move_to_step()> |
| 119 |
|
| 120 |
$response = $es->ilm->move_to_step( |
| 121 |
index => $index, # required |
| 122 |
body => {...} # required |
| 123 |
) |
| 124 |
|
| 125 |
The C<move_to_step()> method triggers execution of a specific step in the lifecycle policy. |
| 126 |
|
| 127 |
Query string parameters: |
| 128 |
C<error_trace>, |
| 129 |
C<filter_path>, |
| 130 |
C<human> |
| 131 |
|
| 132 |
See the L<ILM move_to_step docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-move-to-step.html> |
| 133 |
for more information. |
| 134 |
|
| 135 |
=head2 C<retry()> |
| 136 |
|
| 137 |
$response = $es->ilm->retry( |
| 138 |
index => $index, # required |
| 139 |
) |
| 140 |
|
| 141 |
The C<retry()> method retries executing the policy for an index that is in the ERROR step. |
| 142 |
|
| 143 |
Query string parameters: |
| 144 |
C<error_trace>, |
| 145 |
C<filter_path>, |
| 146 |
C<human> |
| 147 |
|
| 148 |
See the L<ILM retry docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-retry.html> |
| 149 |
for more information. |
| 150 |
|
| 151 |
=head2 C<remove_lifecycle()> |
| 152 |
|
| 153 |
$response = $es->ilm->remove_lifecycle( |
| 154 |
index => $index # required |
| 155 |
) |
| 156 |
|
| 157 |
The C<remove_lifecycle()> method removes a lifecycle from the specified index. |
| 158 |
|
| 159 |
Query string parameters: |
| 160 |
C<error_trace>, |
| 161 |
C<filter_path>, |
| 162 |
C<human> |
| 163 |
|
| 164 |
See the L<ILM remove_lifecycle docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-remove-lifecycle.html> |
| 165 |
for more information. |
| 166 |
|
| 167 |
=head2 C<explain_lifecycle()> |
| 168 |
|
| 169 |
$response = $es->ilm->explain_lifecycle( |
| 170 |
index => $index # required |
| 171 |
) |
| 172 |
|
| 173 |
The C<explain_lifecycle()> method returns information about the index’s current lifecycle state. |
| 174 |
|
| 175 |
Query string parameters: |
| 176 |
C<error_trace>, |
| 177 |
C<filter_path>, |
| 178 |
C<human> |
| 179 |
|
| 180 |
See the L<ILM explain_lifecycle docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-explain-lifecycle.html> |
| 181 |
for more information. |
| 182 |
|
| 183 |
=head1 OPERATION MANAGEMENT APIS |
| 184 |
|
| 185 |
=head2 C<status()> |
| 186 |
|
| 187 |
$response = $es->ilm->status; |
| 188 |
|
| 189 |
The C<status()> method returns the current operating mode for ILM. |
| 190 |
|
| 191 |
Query string parameters: |
| 192 |
C<error_trace>, |
| 193 |
C<filter_path>, |
| 194 |
C<human> |
| 195 |
|
| 196 |
See the L<ILM status docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-status.html> |
| 197 |
for more information. |
| 198 |
|
| 199 |
=head2 C<start()> |
| 200 |
|
| 201 |
$response = $es->ilm->start; |
| 202 |
|
| 203 |
The C<start()> method starts the index lifecycle management process. |
| 204 |
|
| 205 |
Query string parameters: |
| 206 |
C<error_trace>, |
| 207 |
C<filter_path>, |
| 208 |
C<human> |
| 209 |
|
| 210 |
See the L<ILM start docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-start.html> |
| 211 |
for more information. |
| 212 |
|
| 213 |
=head2 C<stop()> |
| 214 |
|
| 215 |
$response = $es->ilm->stop; |
| 216 |
|
| 217 |
The C<stop()> method stops the index lifecycle management process. |
| 218 |
|
| 219 |
Query string parameters: |
| 220 |
C<error_trace>, |
| 221 |
C<filter_path>, |
| 222 |
C<human> |
| 223 |
|
| 224 |
See the L<ILM stop docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-stop.html> |
| 225 |
for more information. |
| 226 |
|
| 227 |
=head1 AUTHOR |
| 228 |
|
| 229 |
Enrico Zimuel <[email protected]> |
| 230 |
|
| 231 |
=head1 COPYRIGHT AND LICENSE |
| 232 |
|
| 233 |
This software is Copyright (c) 2024 by Elasticsearch BV. |
| 234 |
|
| 235 |
This is free software, licensed under: |
| 236 |
|
| 237 |
The Apache License, Version 2.0, January 2004 |
| 238 |
|
| 239 |
=cut |
| 240 |
|
| 241 |
__END__ |
| 242 |
|
| 243 |
# ABSTRACT: Plugin providing index lifecycle management APIs for Search::Elasticsearch 8.x |
| 244 |
|