Method: Elasticsearch::API::MachineLearning::Actions#get_overall_buckets

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

#get_overall_buckets(arguments = {}) ⇒ Object

Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :job_id (String) —

    The job IDs for which to calculate overall bucket results

  • :top_n (Integer) —

    The number of top job bucket scores to be used in the overall_score calculation

  • :bucket_span (String) —

    The span of the overall buckets. Defaults to the longest job bucket_span

  • :overall_score (Double) —

    Returns overall buckets with overall scores higher than this value

  • :exclude_interim (Boolean) —

    If true overall buckets that include interim buckets will be excluded

  • :start (String) —

    Returns overall buckets with timestamps after this time

  • :end (String) —

    Returns overall buckets with timestamps earlier than this time

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

  • :body (Hash) —

    Overall bucket selection details if not provided in URI

Raises:

  • (ArgumentError)

See Also:


40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/elasticsearch/api/actions/machine_learning/get_overall_buckets.rb', line 40

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

  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 = arguments.delete(:body)

  _job_id = arguments.delete(:job_id)

  method = if body
             Elasticsearch::API::HTTP_POST
           else
             Elasticsearch::API::HTTP_GET
           end

  path = "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/results/overall_buckets"
  params = Utils.process_params(arguments)

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