1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
# Licensed to Elasticsearch B.V. under one or more contributor
# license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright
# ownership. Elasticsearch B.V. licenses this file to you under
# the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
package Search::Elasticsearch::Client::8_0::Direct::Tasks;
$Search::Elasticsearch::Client::8_0::Direct::Tasks::VERSION = '8.12';
use Moo;
with 'Search::Elasticsearch::Client::8_0::Role::API';
with 'Search::Elasticsearch::Role::Client::Direct';
__PACKAGE__->_install_api('tasks');
1;
=pod
=encoding UTF-8
=head1 NAME
Search::Elasticsearch::Client::8_0::Direct::Tasks - A client for accessing the Task Management API
=head1 VERSION
version 8.12
=head1 DESCRIPTION
This module provides methods to access the Task Management API, such as listing
tasks and cancelling tasks.
It does L<Search::Elasticsearch::Role::Client::Direct>.
=head1 METHODS
=head2 C<list()>
$response = $e->tasks->list(
task_id => $task_id # optional
);
The C<list()> method returns all running tasks or, if a C<task_id> is specified, info
about that task.
Query string parameters:
C<actions>,
C<detailed>,
C<error_trace>,
C<group_by>,
C<human>,
C<nodes>,
C<parent_task_id>,
C<timeout>,
C<wait_for_completion>
See the L<task management docs|http://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html>
for more information.
=head2 C<get()>
$response = $e->tasks->get(
task_id => $task_id # required
);
The C<get()> method returns the task with the specified ID.
Query string parameters:
C<error_trace>,
C<human>,
C<wait_for_completion>
See the L<task management docs|http://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html>
for more information.
=head2 C<cancel()>
$response = $e->tasks->cancel(
task_id => $task_id # required
);
The C<cancel()> method attempts to cancel the specified C<task_id> or multiple tasks.
Query string parameters:
C<actions>,
C<error_trace>,
C<human>,
C<nodes>,
C<parent_task_id>,
C<timeout>
See the L<task management docs|http://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html>
for more information.
=head1 AUTHOR
Enrico Zimuel <enrico.zimuel@elastic.co>
=head1 COPYRIGHT AND LICENSE
This software is Copyright (c) 2024 by Elasticsearch BV.
This is free software, licensed under:
The Apache License, Version 2.0, January 2004
=cut
__END__
# ABSTRACT: A client for accessing the Task Management API
|
