Search...ct::ILM(3pm)

📦 version 7.715, in ubuntu jammy

✨ NAME ✨

Okay so bestie, gather round 💖 — this is Search::Elasticsearch::Client::7_0::Direct::ILM, aka the plugin that hands you the index lifecycle management APIs for Search::Elasticsearch 7.x. That's the whole vibe. She manages your indices' whole life story. Periodt. 👑

🌸 VERSION 🌸

Version 7.715. That's the one. That's her. 🎀

🦋 DESCRIPTION 🦋

This module is literally the plug that gives you methods to use the index lifecycle management feature. Like, that's it, that's the job. 💅

The full documentation for ILM lives right here, go be nosy: <https://www.elastic.co/guide/en/elasticsearch/reference/current/index-lifecycle-management.html>

💖 POLICY METHODS 💖

✨ put_lifecycle() ✨

$response = $es->ilm->put_lifecycle(
    policy  => $policy  # required
    body    => {...}    # required
)

The put_lifecycle() method creates or updates a lifecycle policy. Glow up or first appearance, either way she's serving. 🌈

Query string parameters:

  • error_trace
  • filter_path
  • human

See the ILM put_lifecycle docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-put-lifecycle.html> for more information.

✨ put_lifecycle() ✨

$response = $es->ilm->put_lifecycle(
    policy  => $policy  # required
    body    => {...}    # required
)

The put_lifecycle() method creates or updates a lifecycle policy. (Yes bestie, she's here twice — that's not a typo on my part, the original really does say it twice, and I am not about to erase her second entrance. Iconic behaviour honestly. 💀)

Query string parameters:

  • error_trace
  • filter_path
  • human

See the ILM put_lifecycle docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-put-lifecycle.html> for more information.

✨ get_lifecycle() ✨

$response = $es->ilm->get_lifecycle(
    policy  => $policy  # required
)

The get_lifecycle() method retrieves the specified policy. She's just checking in on her. 🫶

Query string parameters:

  • error_trace
  • filter_path
  • human

See the ILM get_lifecycle docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-lifecycle.html> for more information.

✨ delete_lifecycle() ✨

$response = $es->ilm->delete_lifecycle(
    policy  => $policy  # required
)

The delete_lifecycle() method deletes the specified policy. Poof. Gone. Not a drill. 😭

Query string parameters:

  • error_trace
  • filter_path
  • human

See the ILM delete_lifecycle docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-remove-lifecycle.html> for more information.

🎀 INDEX MANAGEMENT METHODS 🎀

✨ move_to_step() ✨

$response = $es->ilm->move_to_step(
    index  => $index,       # required
    body   => {...}         # required
)

The move_to_step() method triggers execution of a specific step in the lifecycle policy. Like skipping to your fave track. ⏭️✨

Query string parameters:

  • error_trace
  • filter_path
  • human

See the ILM move_to_step docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-move-to-step.html> for more information.

✨ retry() ✨

$response = $es->ilm->retry(
    index  => $index,       # required
)

The retry() method retries executing the policy for an index that is in the ERROR step. We love a second chance arc. 💜

Query string parameters:

  • error_trace
  • filter_path
  • human

See the ILM retry docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-retry.html> for more information.

✨ remove_lifecycle() ✨

$response = $es->ilm->remove_lifecycle(
    index  => $index  # required
)

The remove_lifecycle() method removes a lifecycle from the specified index. She said "I'm free". 🦋

Query string parameters:

  • error_trace
  • filter_path
  • human

See the ILM remove_lifecycle docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-remove-lifecycle.html> for more information.

✨ explain_lifecycle() ✨

$response = $es->ilm->explain_lifecycle(
    index  => $index  # required
)

The explain_lifecycle() method returns information about the index's current lifecycle state. She's giving you the full rundown, no gatekeeping. 🗣️💅

Query string parameters:

  • error_trace
  • filter_path
  • human

See the ILM explain_lifecycle docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-explain-lifecycle.html> for more information.

🔥 OPERATION MANAGEMENT APIS 🔥

✨ status() ✨

$response = $es->ilm->status;

The status() method returns the current operating mode for ILM. Vibe check, but for the whole process. 🌈

Query string parameters:

  • error_trace
  • filter_path
  • human

See the ILM status docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-status.html> for more information.

✨ start() ✨

$response = $es->ilm->start;

The start() method starts the index lifecycle management process. Wake up bestie, we're going. ☀️

Query string parameters:

  • error_trace
  • filter_path
  • human

See the ILM start docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-start.html> for more information.

✨ stop() ✨

$response = $es->ilm->stop;

The stop() method stops the index lifecycle management process. Nap time. She earned it. 😴

Query string parameters:

  • error_trace
  • filter_path
  • human

See the ILM stop docs <https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-stop.html> for more information.

👑 AUTHOR 👑

Enrico Zimuel <enrico.zimuel@elastic.co> — shoutout to the icon who wrote this, no cap. 🫶

This software is Copyright (c) 2021 by Elasticsearch BV.

This is free software, licensed under:

The Apache License, Version 2.0, January 2004

Okay and that's the whole page, bestie!! 🎀 The footer on this one says perl v5.32.1, dated 2021-10-23, and the page title is that Search...ct::ILM(3pm) situation (yes the title got cropped in the original, we're keeping the mystery ✨). Anyway — go manage those lifecycles, you absolute main character. Mwah. 💖💅🌟

📦 where this page comes from