module Elasticsearch::API::Tasks::Actions

Public Instance Methods

cancel(arguments = {}) click to toggle source

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. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.

@option arguments [String] :task_id Cancel the task with specified task id (node_id:task_number) @option arguments [List] :nodes 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 cancelled. Leave empty to cancel all. @option arguments [String] :parent_task_id Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all. @option arguments [Boolean] :wait_for_completion Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false @option arguments [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/8.16/tasks.html

# File lib/elasticsearch/api/actions/tasks/cancel.rb, line 40
def cancel(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'tasks.cancel' }

  defined_params = [:task_id].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _task_id = arguments.delete(:task_id)

  method = Elasticsearch::API::HTTP_POST
  path   = if _task_id
             "_tasks/#{Utils.__listify(_task_id)}/_cancel"
           else
             '_tasks/_cancel'
           end
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end
get(arguments = {}) click to toggle source

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

@option arguments [String] :task_id Return the task with specified id (node_id:task_number) @option arguments [Boolean] :wait_for_completion Wait for the matching tasks to complete (default: false) @option arguments [Time] :timeout Explicit operation timeout @option arguments [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/8.16/tasks.html

# File lib/elasticsearch/api/actions/tasks/get.rb, line 38
def get(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'tasks.get' }

  defined_params = [:task_id].each_with_object({}) do |variable, set_variables|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = nil

  _task_id = arguments.delete(:task_id)

  method = Elasticsearch::API::HTTP_GET
  path   = "_tasks/#{Utils.__listify(_task_id)}"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end
list(arguments = {}) click to toggle source

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

@option arguments [List] :nodes 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_task_id Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all. @option arguments [Boolean] :wait_for_completion Wait for the matching tasks to complete (default: false) @option arguments [String] :group_by Group tasks by nodes or parent/child relationships (options: nodes, parents, none) @option arguments [Time] :timeout Explicit operation timeout @option arguments [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/8.16/tasks.html

# File lib/elasticsearch/api/actions/tasks/list.rb, line 42
def list(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'tasks.list' }

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body   = nil

  method = Elasticsearch::API::HTTP_GET
  path   = '_tasks'
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end