1
2
3[[Elasticsearch_Namespaces_TasksNamespace]]
4=== Elasticsearch\Namespaces\TasksNamespace
5
6
7
8Class TasksNamespace
9
10*Description*
11
12
13NOTE: this file is autogenerated using util/GenerateEndpoints.php
14and Elasticsearch 7.12.1 (3186837139b9c6b6d23c3200870651f10d3343b7)
15
16
17*Methods*
18
19The class defines the following methods:
20
21* <<Elasticsearch_Namespaces_TasksNamespacecancel_cancel,`cancel()`>>
22* <<Elasticsearch_Namespaces_TasksNamespaceget_get,`get()`>>
23* <<Elasticsearch_Namespaces_TasksNamespacelist_list,`list()`>>
24* <<Elasticsearch_Namespaces_TasksNamespacetasksList_tasksList,`tasksList()`>>
25
26
27
28[[Elasticsearch_Namespaces_TasksNamespacecancel_cancel]]
29.`cancel(array $params = [])`
30*NOTE:* This API is EXPERIMENTAL and may be changed or removed completely in a future release
31****
32[source,php]
33----
34/*
35$params['task_id']             = (string) Cancel the task with specified task id (node_id:task_number)
36$params['nodes']               = (list) A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
37$params['actions']             = (list) A comma-separated list of actions that should be cancelled. Leave empty to cancel all.
38*/
39----
40****
41
42
43
44[[Elasticsearch_Namespaces_TasksNamespaceget_get]]
45.`get(array $params = [])`
46*NOTE:* This API is EXPERIMENTAL and may be changed or removed completely in a future release
47****
48[source,php]
49----
50/*
51$params['task_id']             = (string) Return the task with specified id (node_id:task_number)
52$params['wait_for_completion'] = (boolean) Wait for the matching tasks to complete (default: false)
53$params['timeout']             = (time) Explicit operation timeout
54*/
55----
56****
57
58
59
60[[Elasticsearch_Namespaces_TasksNamespacelist_list]]
61.`list(array $params = [])`
62*NOTE:* This API is EXPERIMENTAL and may be changed or removed completely in a future release
63****
64[source,php]
65----
66/*
67$params['nodes']               = (list) A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
68$params['actions']             = (list) A comma-separated list of actions that should be returned. Leave empty to return all.
69*/
70----
71****
72
73
74
75[[Elasticsearch_Namespaces_TasksNamespacetasksList_tasksList]]
76.`tasksList(array $params = [])`
77****
78[source,php]
79----
80/*
81Proxy function to list() to prevent BC break since 7.4.0
82*/
83----
84****
85
86
87