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

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

Instance Method Summary collapse

Instance Method Details

#info(arguments = {}) ⇒ Object

Retrieve information about xpack, including build number/timestamp and license status

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :human (Boolean) —

    Presents additional info for humans (feature descriptions and X-Pack tagline)

  • :categories (List) —

    Comma-separated list of info categories. (Options: build, license, features)

See Also:



19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/elasticsearch/xpack/api/actions/info.rb', line 19

def info(arguments={})
  valid_params = [
    :human,
    :categories ]

  method = Elasticsearch::API::HTTP_GET
  path   = "_xpack"
  params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
  body   = nil

  perform_request(method, path, params, body).body
end

#usage(arguments = {}) ⇒ Object

Retrieve information about X-Pack features usage

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :master_timeout (Duration) —

    Specify timeout for watch write operation



15
16
17
18
19
20
21
22
23
 
# File 'lib/elasticsearch/xpack/api/actions/usage.rb', line 15

def usage(arguments={})
  valid_params = [ :master_timeout ]
  method = Elasticsearch::API::HTTP_GET
  path   = "_xpack/usage"
  params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
  body   = nil

  perform_request(method, path, params, body).body
end