Class Tasks
The Tasks class
Info:
- Author: Dhaval Kapil
Methods
| Tasks:cancel (params) | Cancel function |
| Tasks:get (params) | Get function |
Methods
- Tasks:cancel (params)
-
Cancel function
Parameters:
- params
The cancel Parameters
Returns:
-
table Error or the data received from the elasticsearch server
Usage:
params["task_id"] = (string) Cancel the task with specified task id (node_id:task_number) ["node_id"] = (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 ["actions"] = (list) A comma-separated list of actions that should be cancelled. Leave empty to cancel all. ["parent_node"] = (string) Cancel tasks with specified parent node. ["parent_task"] = (string) Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all.
- params
- Tasks:get (params)
-
Get function
Parameters:
- params
The get Parameters
Returns:
-
table Error or the data received from the elasticsearch server
Usage:
params["task_id"] = (string) Return the task with specified id (node_id:task_number) ["node_id"] = (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 ["actions"] = (list) A comma-separated list of actions that should be returned. Leave empty to return all. ["detailed"] = (boolean) Return detailed task information (default: false) ["parent_node"] = (string) Return tasks with specified parent node. ["parent_task"] = (string) Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all. ["wait_for_completion"] = (boolean) Wait for the matching tasks to complete (default: false)
- params