Method: Elasticsearch::API::Cat::Actions#help

Defined in:
lib/elasticsearch/api/actions/cat/help.rb

#help(arguments = {}) ⇒ Object

Returns help for the Cat APIs.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :help (Boolean) —

    Return help information

  • :s (List) —

    Comma-separated list of column names or column aliases to sort by

  • :headers (Hash) —

    Custom HTTP headers

See Also:


33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/elasticsearch/api/actions/cat/help.rb', line 33

def help(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || "cat.help" }

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

  body   = nil

  method = Elasticsearch::API::HTTP_GET
  path   = "_cat"
  params = Utils.process_params(arguments)

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