logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

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

Author

       Enrico Zimuel <enrico.zimuel@elastic.co>

Description

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

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

Methods

"list()"
           $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.

   "cancel()"
           $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.

Name

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

Version

       version 6.81

See Also