Method: Elasticsearch::API::MachineLearning::Actions#get_job_stats

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

#get_job_stats(arguments = {}) ⇒ Object

Retrieves usage information for anomaly detection jobs.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :job_id (String)

    The ID of the jobs stats to fetch

  • :allow_no_match (Boolean)

    Whether to ignore if a wildcard expression matches no jobs. (This includes ‘_all` string or when no jobs have been specified)

  • :headers (Hash)

    Custom HTTP headers

See Also:

[View source]

33
34
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/get_job_stats.rb', line 33

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

  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?

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

  body = nil

  _job_id = arguments.delete(:job_id)

  method = Elasticsearch::API::HTTP_GET
  path   = if _job_id
             "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/_stats"
           else
             '_ml/anomaly_detectors/_stats'
           end
  params = Utils.process_params(arguments)

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