Module: Elasticsearch::API::XPack::Actions

Included in:
XPackClient
Defined in:
lib/elasticsearch/api/namespace/xpack.rb,
lib/elasticsearch/api/actions/xpack/info.rb,
lib/elasticsearch/api/actions/xpack/usage.rb

Instance Method Summary collapse

Instance Method Details

#info(arguments = {}) ⇒ Object

Retrieves information about the installed X-Pack features.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :categories (List)

    Comma-separated list of info categories. Can be any of: build, license, features

  • :accept_enterprise (Boolean)

    If this param is used it must be set to true Deprecated

  • :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/xpack/info.rb', line 33

def info(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || "xpack.info" }

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

  body   = nil

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

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

#usage(arguments = {}) ⇒ Object

Retrieves usage information about the installed X-Pack features.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :master_timeout (Time)

    Specify timeout for watch write operation

  • :headers (Hash)

    Custom HTTP headers

See Also:



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

def usage(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || "xpack.usage" }

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

  body   = nil

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

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