Search...::Tasks(3pm)

✨ NAME ✨

Search::Elasticsearch::Client::2_0::Direct::Tasks — bestie, this is a client for accessing the Task Management API 💅 (yes, the perl doc for it, we're doing this, stay with me)

---

🎀 VERSION 🎀

version 6.81

---

🌸 DESCRIPTION 🌸

okay so this module hands you the methods to go poke at the Task Management API — like listing your tasks and cancelling your tasks. the way that it does its whole thing is by doing Search::Elasticsearch::Role::Client::Direct. slay.

---

💖 METHODS 💖

🦋 list()

$response = $e->tasks->list(
    task_id => $task_id  # optional
);

the list() method gives you back every running task, or — if you pass a task_id — the info about that one specific task. iconic behaviour honestly.

query string parameters you can throw in there:

• actions
• detailed
• node_id
• parent_node
• parent_task
• wait_for_completion

for more info, go read the task management docs: http://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html

---

🫶 cancel()

$response = $e->tasks->cancel(
    task_id => $task_id  # option
);

the cancel() method attempts to cancel the task_id you specify, or a whole bunch of tasks at once. attempting, bestie, we said attempting, no promises 👀

query string parameters:

• actions
• node_id
• parent_node
• parent_task

for more info, the task management docs are right here: http://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html

---

👑 AUTHOR 👑

Enrico Zimuel <enrico.zimuel@elastic.co>

---

🌈 COPYRIGHT AND LICENSE 🌈

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

This is free software, licensed under:

The Apache License, Version 2.0, January 2004

---

and that's the whole page, bestie 💖 this one came from perl v5.32.0, dated 2020-11-25 — go forth and manage those tasks, you absolute main character 🎀✨