Search::Elasticsearch::Client::2_0::Direct::Tasks - A client for accessing the Task Management API
version 2.02
This module provides methods to access the Task Management API, such as listing tasks and cancelling tasks.
It does Search::Elasticsearch::Role::Client::Direct.
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.
task_id
Query string parameters: actions, detailed, node_id, parent_node, parent_task, wait_for_completion
actions
detailed
node_id
parent_node
parent_task
wait_for_completion
See the task management docs 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
Clinton Gormley <drtech@cpan.org>
This software is Copyright (c) 2016 by Elasticsearch BV.
This is free software, licensed under:
The Apache License, Version 2.0, January 2004
To install Search::Elasticsearch, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Search::Elasticsearch
CPAN shell
perl -MCPAN -e shell install Search::Elasticsearch
For more information on module installation, please visit the detailed CPAN module installation guide.