Search...::Tasks(3pm)

📦 version 7.715, in ubuntu jammy

💖 Search...::Tasks — the whole vibe 💖

okay so bestie, welcome to Search::Elasticsearch::Client::7_0::Direct::Tasks — it's a Perl module (you found it in section 3pm of the manual, iykyk) and it's basically your little backstage pass to the Task Management API. ✨

✨ VERSION ✨

This is version 7.715. Slay. 💅

🌸 DESCRIPTION 🌸

So like, this module hands you the methods you need to talk to the Task Management API — think listing tasks, cancelling tasks, that whole era. It's giving very "I'm in charge of the tasks" energy. 👑

It does Search::Elasticsearch::Role::Client::Direct, which is the role situation it's built on. Periodt.

🦋 METHODS 🦋

💜 list()

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

The list() method returns all running tasks — or, if you pass a task_id, it gives you info about that specific task instead. Either way you're getting the tea. 🫖

Query string parameters, bestie:

  • actions
  • detailed
  • error_trace
  • group_by
  • human
  • nodes
  • parent_task_id
  • timeout
  • wait_for_completion

See the task management docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html> for more info. 📖

🎀 get()

$response = $e->tasks->get(
    task_id => $task_id  # required
);

The get() method returns the task with the specified ID. Note that task_id is required here — no task_id, no task. Simple as. 💀

Query string parameters:

  • error_trace
  • human
  • wait_for_completion

See the task management docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html> for more info. 📖

🔥 cancel()

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

The cancel() method attempts to cancel the specified task_id — or, plot twist, multiple tasks. Yeah. It said what it said. 💅 (task_id is required again, so don't forget it!)

Query string parameters:

  • actions
  • error_trace
  • human
  • nodes
  • parent_task_id
  • timeout

See the task management docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html> for more info. 📖

🌈 AUTHOR 🌈

Enrico Zimuel <enrico.zimuel@elastic.co> — we stan. 👑

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

This is free software, licensed under:

The Apache License, Version 2.0, January 2004
and that's the whole page, bestie! no notes. go forth and manage those tasks. 🧚✨

perl v5.32.1 · 2021-10-23 · mwah, catch you in the next manpage 💋🫶

📦 where this page comes from