Method: Elasticsearch::API::MachineLearning::Actions#get_filters

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

#get_filters(arguments = {}) ⇒ Object

Retrieves filters.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :filter_id (String) —

    The ID of the filter to fetch

  • :from (Integer) —

    skips a number of filters

  • :size (Integer) —

    specifies a max number of filters to get

  • :headers (Hash) —

    Custom HTTP headers

See Also:

[View source]

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
60
 
# File 'lib/elasticsearch/api/actions/machine_learning/get_filters.rb', line 34

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

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

  _filter_id = arguments.delete(:filter_id)

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

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