1Search::Elasticsearch::UCsleireSnCetoa:nr:tc7rh_i:0b::uE:tlDeaidsrtePicectrs:le:aTDraocschku:sm:(eC3nl)tiaetnito:n:7_0::Direct::Tasks(3)
2
3
4

NAME

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

VERSION

10       version 7.715
11

DESCRIPTION

13       This module provides methods to access the Task Management API, such as
14       listing tasks and cancelling tasks.
15
16       It does Search::Elasticsearch::Role::Client::Direct.
17

METHODS

19   "list()"
20           $response = $e->tasks->list(
21               task_id => $task_id  # optional
22           );
23
24       The "list()" method returns all running tasks or, if a "task_id" is
25       specified, info about that task.
26
27       Query string parameters:
28           "actions",
29           "detailed",
30           "error_trace",
31           "group_by",
32           "human",
33           "nodes",
34           "parent_task_id",
35           "timeout",
36           "wait_for_completion"
37
38       See the task management docs
39       <http://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html>
40       for more information.
41
42   "get()"
43           $response = $e->tasks->get(
44               task_id => $task_id  # required
45           );
46
47       The "get()" method returns the task with the specified ID.
48
49       Query string parameters:
50           "error_trace",
51           "human",
52           "wait_for_completion"
53
54       See the task management docs
55       <http://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html>
56       for more information.
57
58   "cancel()"
59           $response = $e->tasks->cancel(
60               task_id => $task_id  # required
61           );
62
63       The "cancel()" method attempts to cancel the specified "task_id" or
64       multiple tasks.
65
66       Query string parameters:
67           "actions",
68           "error_trace",
69           "human",
70           "nodes",
71           "parent_task_id",
72           "timeout"
73
74       See the task management docs
75       <http://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html>
76       for more information.
77

AUTHOR

79       Enrico Zimuel <enrico.zimuel@elastic.co>
80

82       This software is Copyright (c) 2021 by Elasticsearch BV.
83
84       This is free software, licensed under:
85
86         The Apache License, Version 2.0, January 2004
87
88
89
90perl v5.34.0              Search::2E0l2a2s-t0i1c-s2e1arch::Client::7_0::Direct::Tasks(3)
Impressum