Method: Elasticsearch::API::MachineLearning::Actions#get_data_frame_analytics

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

#get_data_frame_analytics(arguments = {}) ⇒ Object

Retrieves configuration information for data frame analytics jobs.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :id (String) —

    The ID of the data frame analytics to fetch

  • :allow_no_match (Boolean) —

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

  • :from (Integer) —

    skips a number of analytics

  • :size (Integer) —

    specifies a max number of analytics to get

  • :exclude_generated (Boolean) —

    Omits fields that are illegal to set on data frame analytics PUT

  • :headers (Hash) —

    Custom HTTP headers

See Also:

[View source]

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

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

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

  _id = arguments.delete(:id)

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

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