Scroll to navigation

Search::Elasticsearch::Client::8_0::Direct::Tasks(3pm) User Contributed Perl Documentation Search::Elasticsearch::Client::8_0::Direct::Tasks(3pm)

NAME

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

VERSION

version 8.00

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",
"error_trace",
"group_by",
"human",
"nodes",
"parent_task_id",
"timeout",
"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:
"error_trace",
"human",
"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  # required
    );

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

Query string parameters:
"actions",
"error_trace",
"human",
"nodes",
"parent_task_id",
"timeout"

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

AUTHOR

Enrico Zimuel <enrico.zimuel@elastic.co>

COPYRIGHT AND LICENSE

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

This is free software, licensed under:

  The Apache License, Version 2.0, January 2004
2023-02-11 perl v5.36.0