Reference

Search::Elasticsearch::Client::5_0::Direct::Tasks(3pm)

A client for accessing the Task Management API

NAME

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

VERSION

version 5.01

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",
"group_by",
"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.

"get()"

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

The "get()" method returns the task with the specified ID.

Query string parameters:
"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.

AUTHOR

Clinton Gormley <[email protected]>

COPYRIGHT AND LICENSE

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

This is free software, licensed under:

  The Apache License, Version 2.0, January 2004