Method: Elasticsearch::API::MachineLearning::Actions#delete_job

Defined in:
lib/elasticsearch/api/actions/machine_learning/delete_job.rb

#delete_job(arguments = {}) ⇒ Object

Deletes an existing anomaly detection job.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :job_id (String) —

    The ID of the job to delete

  • :force (Boolean) —

    True if the job should be forcefully deleted

  • :wait_for_completion (Boolean) —

    Should this request wait until the operation has completed before returning

  • :delete_user_annotations (Boolean) —

    Should annotations added by the user be deleted

  • :headers (Hash) —

    Custom HTTP headers

Raises:

  • (ArgumentError)

See Also:


35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/elasticsearch/api/actions/machine_learning/delete_job.rb', line 35

def delete_job(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_job' }

  defined_params = [:job_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?

  raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]

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

  body = nil

  _job_id = arguments.delete(:job_id)

  method = Elasticsearch::API::HTTP_DELETE
  path   = "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}"
  params = Utils.process_params(arguments)

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