module Elasticsearch::XPack::API::License::Actions

Public Instance Methods

delete(arguments = {}) click to toggle source

Deletes licensing information for the cluster

@option arguments [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/7.14/delete-license.html

# File lib/elasticsearch/xpack/api/actions/license/delete.rb, line 29
def delete(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  method = Elasticsearch::API::HTTP_DELETE
  path   = "_license"
  params = {}

  body = nil
  perform_request(method, path, params, body, headers).body
end
get(arguments = {}) click to toggle source

Retrieves licensing information for the cluster

@option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) @option arguments [Boolean] :accept_enterprise If the active license is an enterprise license, return type as 'enterprise' (default: false) @option arguments [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/7.14/get-license.html

# File lib/elasticsearch/xpack/api/actions/license/get.rb, line 31
def get(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  method = Elasticsearch::API::HTTP_GET
  path   = "_license"
  params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

  body = nil
  perform_request(method, path, params, body, headers).body
end
get_basic_status(arguments = {}) click to toggle source

Retrieves information about the status of the basic license.

@option arguments [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/7.14/get-basic-status.html

# File lib/elasticsearch/xpack/api/actions/license/get_basic_status.rb, line 29
def get_basic_status(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  method = Elasticsearch::API::HTTP_GET
  path   = "_license/basic_status"
  params = {}

  body = nil
  perform_request(method, path, params, body, headers).body
end
get_trial_status(arguments = {}) click to toggle source

Retrieves information about the status of the trial license.

@option arguments [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/7.14/get-trial-status.html

# File lib/elasticsearch/xpack/api/actions/license/get_trial_status.rb, line 29
def get_trial_status(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  method = Elasticsearch::API::HTTP_GET
  path   = "_license/trial_status"
  params = {}

  body = nil
  perform_request(method, path, params, body, headers).body
end
post(arguments = {}) click to toggle source

Updates the license for the cluster.

@option arguments [Boolean] :acknowledge whether the user has acknowledged acknowledge messages (default: false) @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body licenses to be installed

@see www.elastic.co/guide/en/elasticsearch/reference/7.14/update-license.html

# File lib/elasticsearch/xpack/api/actions/license/post.rb, line 31
def post(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  method = Elasticsearch::API::HTTP_PUT
  path   = "_license"
  params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

  body = arguments[:body]
  perform_request(method, path, params, body, headers).body
end
post_start_basic(arguments = {}) click to toggle source

Starts an indefinite basic license.

@option arguments [Boolean] :acknowledge whether the user has acknowledged acknowledge messages (default: false) @option arguments [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/7.14/start-basic.html

# File lib/elasticsearch/xpack/api/actions/license/post_start_basic.rb, line 30
def post_start_basic(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  method = Elasticsearch::API::HTTP_POST
  path   = "_license/start_basic"
  params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

  body = nil
  perform_request(method, path, params, body, headers).body
end
post_start_trial(arguments = {}) click to toggle source

starts a limited time trial license.

@option arguments [String] :type The type of trial license to generate (default: “trial”) @option arguments [Boolean] :acknowledge whether the user has acknowledged acknowledge messages (default: false) @option arguments [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/7.14/start-trial.html

# File lib/elasticsearch/xpack/api/actions/license/post_start_trial.rb, line 31
def post_start_trial(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  method = Elasticsearch::API::HTTP_POST
  path   = "_license/start_trial"
  params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

  body = nil
  perform_request(method, path, params, body, headers).body
end