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

Included in:
LicenseClient
Defined in:
lib/elasticsearch/xpack/api/namespace/license.rb,
lib/elasticsearch/xpack/api/actions/license/get.rb,
lib/elasticsearch/xpack/api/actions/license/post.rb,
lib/elasticsearch/xpack/api/actions/license/delete.rb,
lib/elasticsearch/xpack/api/actions/license/get_basic_status.rb,
lib/elasticsearch/xpack/api/actions/license/get_trial_status.rb,
lib/elasticsearch/xpack/api/actions/license/post_start_basic.rb,
lib/elasticsearch/xpack/api/actions/license/post_start_trial.rb

Instance Method Summary collapse

Instance Method Details

#delete(arguments = {}) ⇒ Object

Delete a license

See Also:



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

def delete(arguments={})
  method = Elasticsearch::API::HTTP_DELETE
  path   = "_xpack/license"
  params = {}
  body   = nil

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

#get(arguments = {}) ⇒ Object

Get a license

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :local (Boolean) —

    Return local information (default: false)

See Also:



17
18
19
20
21
22
23
24
25
 
# File 'lib/elasticsearch/xpack/api/actions/license/get.rb', line 17

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

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

#get_basic_status(arguments = {}) ⇒ Object

TODO: Description

See Also:



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

def get_basic_status(arguments={})
  method = Elasticsearch::API::HTTP_GET
  path   = "_xpack/license/basic_status"
  params = {}
  body   = nil

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

#get_trial_status(arguments = {}) ⇒ Object

TODO: Description

See Also:



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

def get_trial_status(arguments={})
  method = Elasticsearch::API::HTTP_GET
  path   = "_xpack/license/trial_status"
  params = {}
  body   = nil

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

#post(arguments = {}) ⇒ Object

Install a license

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :body (Hash) —

    Licenses to be installed

  • :acknowledge (Boolean) —

    Whether the user has acknowledged acknowledge messages (default: false)

See Also:



19
20
21
22
23
24
25
26
27
 
# File 'lib/elasticsearch/xpack/api/actions/license/post.rb', line 19

def post(arguments={})
  valid_params = [ :acknowledge ]
  method = Elasticsearch::API::HTTP_PUT
  path   = "_xpack/license"
  params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
  body   = arguments[:body]

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

#post_start_basic(arguments = {}) ⇒ Object

TODO: Description

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :acknowledge (Boolean) —

    whether the user has acknowledged acknowledge messages (default: false)

See Also:



17
18
19
20
21
22
23
24
25
26
 
# File 'lib/elasticsearch/xpack/api/actions/license/post_start_basic.rb', line 17

def post_start_basic(arguments={})
  valid_params = [
    :acknowledge ]
  method = Elasticsearch::API::HTTP_POST
  path   = "_xpack/license/start_basic"
  params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
  body   = nil

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

#post_start_trial(arguments = {}) ⇒ Object

TODO: Description

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :type (String) —

    The type of trial license to generate (default: “trial”)

  • :acknowledge (Boolean) —

    whether the user has acknowledged acknowledge messages (default: false)

See Also:



18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/elasticsearch/xpack/api/actions/license/post_start_trial.rb', line 18

def post_start_trial(arguments={})
  valid_params = [
    :type,
    :acknowledge ]
  method = Elasticsearch::API::HTTP_POST
  path   = "_xpack/license/start_trial"
  params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
  body   = nil

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