module Elasticsearch::API::License::Actions

Public Instance Methods

delete(arguments = {}) click to toggle source

Deletes licensing information for the cluster

@option arguments [Time] :master_timeout Timeout for processing on master node @option arguments [Time] :timeout Timeout for acknowledgement of update from all nodes in cluster @option arguments [Hash] :headers Custom HTTP headers

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

# File lib/elasticsearch/api/actions/license/delete.rb, line 33
def delete(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'license.delete' }

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

  body   = nil

  method = Elasticsearch::API::HTTP_DELETE
  path   = '_license'
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
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 Supported for backwards compatibility with 7.x. If this param is used it must be set to true Deprecated @option arguments [Hash] :headers Custom HTTP headers

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

# File lib/elasticsearch/api/actions/license/get.rb, line 33
def get(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'license.get' }

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

  body   = nil

  method = Elasticsearch::API::HTTP_GET
  path   = '_license'
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
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/8.16/get-basic-status.html

# File lib/elasticsearch/api/actions/license/get_basic_status.rb, line 31
def get_basic_status(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'license.get_basic_status' }

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

  body   = nil

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

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
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/8.16/get-trial-status.html

# File lib/elasticsearch/api/actions/license/get_trial_status.rb, line 31
def get_trial_status(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'license.get_trial_status' }

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

  body   = nil

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

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
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 [Time] :master_timeout Timeout for processing on master node @option arguments [Time] :timeout Timeout for acknowledgement of update from all nodes in cluster @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body licenses to be installed

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

# File lib/elasticsearch/api/actions/license/post.rb, line 35
def post(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'license.post' }

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

  body   = arguments.delete(:body)

  method = Elasticsearch::API::HTTP_PUT
  path   = '_license'
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
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 [Time] :master_timeout Timeout for processing on master node @option arguments [Time] :timeout Timeout for acknowledgement of update from all nodes in cluster @option arguments [Hash] :headers Custom HTTP headers

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

# File lib/elasticsearch/api/actions/license/post_start_basic.rb, line 34
def post_start_basic(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'license.post_start_basic' }

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

  body   = nil

  method = Elasticsearch::API::HTTP_POST
  path   = '_license/start_basic'
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
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 [Time] :master_timeout Timeout for processing on master node @option arguments [Time] :timeout Timeout for acknowledgement of update from all nodes in cluster @option arguments [Hash] :headers Custom HTTP headers

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

# File lib/elasticsearch/api/actions/license/post_start_trial.rb, line 35
def post_start_trial(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'license.post_start_trial' }

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

  body   = nil

  method = Elasticsearch::API::HTTP_POST
  path   = '_license/start_trial'
  params = Utils.process_params(arguments)

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