DOKK / manpages / debian 12 / libsearch-elasticsearch-client-2-0-perl / Search::Elasticsearch::Client::2_0::Direct::Tasks.3pm.en
Search::Elasticsearch::Client::2_0::Direct::Tasks(3pm) User Contributed Perl Documentation Search::Elasticsearch::Client::2_0::Direct::Tasks(3pm)

Search::Elasticsearch::Client::2_0::Direct::Tasks - A client for accessing the Task Management API

version 6.81

This module provides methods to access the Task Management API, such as listing tasks and cancelling tasks.

It does Search::Elasticsearch::Role::Client::Direct.

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

The "list()" method returns all running tasks or, if a "task_id" is specified, info about that task.

Query string parameters:
"actions",
"detailed",
"node_id",
"parent_node",
"parent_task",
"wait_for_completion"

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

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

The "cancel()" method attempts to cancel the specified "task_id" or multiple tasks.

Query string parameters:
"actions",
"node_id",
"parent_node",
"parent_task"

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

Enrico Zimuel <enrico.zimuel@elastic.co>

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

This is free software, licensed under:

  The Apache License, Version 2.0, January 2004
2020-11-25 perl v5.32.0