Method: Elasticsearch::API::MachineLearning::Actions#set_upgrade_mode

Defined in:
lib/elasticsearch/api/actions/machine_learning/set_upgrade_mode.rb

#set_upgrade_mode(arguments = {}) ⇒ Object

Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :enabled (Boolean) —

    Whether to enable upgrade_mode ML setting or not. Defaults to false.

  • :timeout (Time) —

    Controls the time to wait before action times out. Defaults to 30 seconds

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

def set_upgrade_mode(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || 'ml.set_upgrade_mode' }

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

  body   = nil

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

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