Module: Elasticsearch::API::Tasks::Actions

Included in:
TasksClient
Defined in:
lib/elasticsearch/api/namespace/tasks.rb,
lib/elasticsearch/api/actions/tasks/get.rb,
lib/elasticsearch/api/actions/tasks/list.rb,
lib/elasticsearch/api/actions/tasks/cancel.rb

Instance Method Summary collapse

Instance Method Details

#cancel(arguments = {}) ⇒ Object

Cancel a specific task

Parameters:

  • arguments (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (arguments):

  • :task_id (Number) —

    Cancel the task with specified id

  • :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.

  • :parent_node (String) —

    Cancel tasks with specified parent node.

  • :parent_task (Number) —

    Cancel tasks with specified parent task id. Set to -1 to cancel all.

See Also:



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/elasticsearch/api/actions/tasks/cancel.rb', line 20

def cancel(arguments={})
  valid_params = [
    :node_id,
    :actions,
    :parent_node,
    :parent_task ]

  arguments = arguments.clone

  task_id = arguments.delete(:task_id)

  method = 'POST'
  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

#get(arguments = {}) ⇒ Object

Return information about a specific task

Parameters:

  • arguments (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (arguments):

  • :task_id (String) —

    Return the task with specified id (node_id:task_number)

  • :wait_for_completion (Boolean) —

    Wait for the matching tasks to complete (default: false)

See Also:



13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/elasticsearch/api/actions/tasks/get.rb', line 13

def get(arguments={})
  valid_params = [ :wait_for_completion ]

  arguments = arguments.clone

  task_id = arguments.delete(:task_id)

  method = HTTP_GET
  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

#list(arguments = {}) ⇒ Object

Return the list of tasks

Parameters:

  • arguments (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (arguments):

  • :task_id (Number) —

    Return the task with specified id

  • :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 (Number) —

    Return tasks with specified parent task id. Set to -1 to return all.

  • :group_by (String) —

    Group tasks by nodes or parent/child relationships Options: nodes, parents

  • :wait_for_completion (Boolean) —

    Wait for the matching tasks to complete (default: false)

See Also:



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# 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 ]

  arguments = arguments.clone

  task_id = arguments.delete(:task_id)

  method = 'GET'
  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