Module: OpenSearch::API::Tasks::Actions

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

Defined Under Namespace

Modules: ParamsRegistry

Instance Method Summary collapse

Instance Method Details

#cancel(arguments = {}) ⇒ Object

Cancels a task, if it can be cancelled through an API. This functionality is Experimental and may be changed or removed completely in a future release. OpenSearch will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :task_id (String) —

    Cancel the task with specified task id (node_id:task_number)

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

  • :actions (List) —

    A comma-separated list of actions that should be cancelled. Leave empty to cancel all.

  • :parent_task_id (String) —

    Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all.

  • :wait_for_completion (Boolean) —

    Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false

  • :headers (Hash) —

    Custom HTTP headers



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/opensearch/api/actions/tasks/cancel.rb', line 45

def cancel(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  _task_id = arguments.delete(:task_id)

  method = OpenSearch::API::HTTP_POST
  path   = if _task_id
             "_tasks/#{Utils.__listify(_task_id)}/_cancel"
           else
             '_tasks/_cancel'
           end
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

  body = nil
  perform_request(method, path, params, body, headers).body
end

#get(arguments = {}) ⇒ Object

Returns information about a task. This functionality is Experimental and may be changed or removed completely in a future release. OpenSearch will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.

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)

  • :timeout (Time) —

    Explicit operation timeout

  • :headers (Hash) —

    Custom HTTP headers



43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/opensearch/api/actions/tasks/get.rb', line 43

def get(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  _task_id = arguments.delete(:task_id)

  method = OpenSearch::API::HTTP_GET
  path   = "_tasks/#{Utils.__listify(_task_id)}"
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

  body = nil
  perform_request(method, path, params, body, headers).body
end

#list(arguments = {}) ⇒ Object

Returns a list of tasks. This functionality is Experimental and may be changed or removed completely in a future release. OpenSearch will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

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

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

  • :group_by (String) —

    Group tasks by nodes or parent/child relationships (options: nodes, parents, none)

  • :timeout (Time) —

    Explicit operation timeout

  • :headers (Hash) —

    Custom HTTP headers



47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/opensearch/api/actions/tasks/list.rb', line 47

def list(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  method = OpenSearch::API::HTTP_GET
  path   = '_tasks'
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

  body = nil
  perform_request(method, path, params, body, headers).body
end