Method: Elasticsearch::API::Cat::Actions#plugins

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

#plugins(arguments = {}) ⇒ Object

Returns information about installed plugins across nodes node.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :format (String) —

    a short version of the Accept header, e.g. json, yaml

  • :local (Boolean) —

    Return local information, do not retrieve the state from master node (default: false)

  • :master_timeout (Time) —

    Explicit operation timeout for connection to master node

  • :h (List) —

    Comma-separated list of column names to display

  • :help (Boolean) —

    Return help information

  • :include_bootstrap (Boolean) —

    Include bootstrap plugins in the response

  • :s (List) —

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

  • :v (Boolean) —

    Verbose mode. Display column headers

  • :headers (Hash) —

    Custom HTTP headers

See Also:


39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/elasticsearch/api/actions/cat/plugins.rb', line 39

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

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

  body   = nil

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

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