Debian Codegraph @

lib/Search/Elasticsearch/Client/8_0/Direct/Tasks.pm

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