module Elasticsearch::API::Tasks::Actions
Public Instance Methods
Cancel a specific task
@option arguments [Number] :task_id Cancel the task with specified id @option arguments [List] :node_id 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
@option arguments [List] :actions A comma-separated list of actions that should be returned.
Leave empty to return all.
@option arguments [String] :parent_node Cancel tasks with specified parent node. @option arguments [Number] :parent_task Cancel tasks with specified parent task id.
Set to -1 to cancel all.
@see www.elastic.co/guide/en/elasticsearch/reference/master/tasks-cancel.html
# File lib/elasticsearch/api/actions/tasks/cancel.rb, line 20 def cancel(arguments={}) valid_params = [ :node_id, :actions, :parent_node, :parent_task ] task_id = arguments.delete(:task_id) method = 'POST' path = "_tasks" path = Utils.__pathify( '_tasks', Utils.__escape(task_id), '_cancel' ) params = Utils.__validate_and_extract_params arguments, valid_params body = nil perform_request(method, path, params, body).body end
Return the list of tasks
@option arguments [Number] :task_id Return the task with specified id @option arguments [List] :node_id 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
@option arguments [List] :actions A comma-separated list of actions that should be returned.
Leave empty to return all.
@option arguments [Boolean] :detailed Return detailed task information (default: false) @option arguments [String] :parent_node Return tasks with specified parent node. @option arguments [Number] :parent_task Return tasks with specified parent task id.
Set to -1 to return all.
@option arguments [String] :group_by Group tasks by nodes or parent/child relationships
Options: nodes, parents
@option arguments [Boolean] :wait_for_completion Wait for the matching tasks to complete (default: false)
@see www.elastic.co/guide/en/elasticsearch/reference/master/tasks-list.html
# File lib/elasticsearch/api/actions/tasks/list.rb, line 24 def list(arguments={}) valid_params = [ :node_id, :actions, :detailed, :parent_node, :parent_task, :group_by, :wait_for_completion ] unsupported_params = [ :group_by ] Utils.__report_unsupported_parameters(arguments.keys, unsupported_params) task_id = arguments.delete(:task_id) method = 'GET' path = "_tasks" path = Utils.__pathify( '_tasks', Utils.__escape(task_id) ) params = Utils.__validate_and_extract_params arguments, valid_params body = nil perform_request(method, path, params, body).body end