GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Search::Elasticsearch::Client::2_0::Direct::Tasks(3) User Contributed Perl Documentation Search::Elasticsearch::Client::2_0::Direct::Tasks(3)

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

version 5.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.

    $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.

Clinton Gormley <drtech@cpan.org>

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

This is free software, licensed under:

  The Apache License, Version 2.0, January 2004
2017-04-02 perl v5.32.1

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.