Method: Elasticsearch::API::MachineLearning::Actions#get_calendars

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

#get_calendars(arguments = {}) ⇒ Object

Retrieves configuration information for calendars.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :calendar_id (String) —

    The ID of the calendar to fetch

  • :from (Integer) —

    skips a number of calendars

  • :size (Integer) —

    specifies a max number of calendars to get

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    The from and size parameters optionally sent in the body

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
60
61
62
63
64
65
66
 
# File 'lib/elasticsearch/api/actions/machine_learning/get_calendars.rb', line 35

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

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

  _calendar_id = arguments.delete(:calendar_id)

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

  path = if _calendar_id
           "_ml/calendars/#{Utils.__listify(_calendar_id)}"
         else
           '_ml/calendars'
         end
  params = Utils.process_params(arguments)

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