# 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::ILM; $Search::Elasticsearch::Client::8_0::Direct::ILM::VERSION = '8.12'; use Moo; with 'Search::Elasticsearch::Client::8_0::Role::API'; with 'Search::Elasticsearch::Role::Client::Direct'; use Search::Elasticsearch::Util qw(parse_params); use namespace::clean; __PACKAGE__->_install_api('ilm'); 1; =pod =encoding UTF-8 =head1 NAME Search::Elasticsearch::Client::8_0::Direct::ILM - Plugin providing index lifecycle management APIs for Search::Elasticsearch 8.x =head1 VERSION version 8.12 =head2 DESCRIPTION This module provides methods to use the index lifecycle management feature. The full documentation for ILM is available here: L =head1 POLICY METHODS =head2 C $response = $es->ilm->put_lifecycle( policy => $policy # required body => {...} # required ) The C method creates or updates a lifecycle policy. Query string parameters: C, C, C See the L for more information. =head2 C $response = $es->ilm->put_lifecycle( policy => $policy # required body => {...} # required ) The C method creates or updates a lifecycle policy. Query string parameters: C, C, C See the L for more information. =head2 C $response = $es->ilm->get_lifecycle( policy => $policy # required ) The C method retrieves the specified policy Query string parameters: C, C, C See the L for more information. =head2 C $response = $es->ilm->delete_lifecycle( policy => $policy # required ) The C method deletes the specified policy Query string parameters: C, C, C See the L for more information. =head1 INDEX MANAGEMENT METHODS =head2 C $response = $es->ilm->move_to_step( index => $index, # required body => {...} # required ) The C method triggers execution of a specific step in the lifecycle policy. Query string parameters: C, C, C See the L for more information. =head2 C $response = $es->ilm->retry( index => $index, # required ) The C method retries executing the policy for an index that is in the ERROR step. Query string parameters: C, C, C See the L for more information. =head2 C $response = $es->ilm->remove_lifecycle( index => $index # required ) The C method removes a lifecycle from the specified index. Query string parameters: C, C, C See the L for more information. =head2 C $response = $es->ilm->explain_lifecycle( index => $index # required ) The C method returns information about the index’s current lifecycle state. Query string parameters: C, C, C See the L for more information. =head1 OPERATION MANAGEMENT APIS =head2 C $response = $es->ilm->status; The C method returns the current operating mode for ILM. Query string parameters: C, C, C See the L for more information. =head2 C $response = $es->ilm->start; The C method starts the index lifecycle management process. Query string parameters: C, C, C See the L for more information. =head2 C $response = $es->ilm->stop; The C method stops the index lifecycle management process. Query string parameters: C, C, C See the L for more information. =head1 AUTHOR Enrico Zimuel =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 index lifecycle management APIs for Search::Elasticsearch 8.x