elasticsearch-api/lib/elasticsearch/api/actions/tasks/cancel.rb
# 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 https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html
#
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.
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 .
def cancel(arguments = {})
          headers = arguments.delete(:headers) || {}
          body = nil
          arguments = arguments.clone
          _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)
          perform_request(method, path, params, body, headers).body
        end
def cancel ( arguments = { } ) headers = arguments . delete ( :headers ) || { } body = nil arguments = arguments . clone _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 ) perform_request ( method , path , params , body , headers ) . body end
Cancels a task, if it can be cancelled through an API.
Cancels a task if it can be cancelled through an API .
arguments
:headers Custom HTTP headers
: headers Custom HTTP headers
see
None