module Elasticsearch::API::Shutdown::Actions

Public Instance Methods

delete_node(arguments = {}) click to toggle source

Removes a node from the shutdown list This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.

@option arguments [String] :node_id The node id of node to be removed from the shutdown state @option arguments [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/current

# File lib/elasticsearch/api/actions/shutdown/delete_node.rb, line 33
def delete_node(arguments = {})
  raise ArgumentError, "Required argument 'node_id' missing" unless arguments[:node_id]

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

  arguments = arguments.clone

  _node_id = arguments.delete(:node_id)

  method = Elasticsearch::API::HTTP_DELETE
  path   = "_nodes/#{Utils.__listify(_node_id)}/shutdown"
  params = {}

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

Retrieve status of a node or nodes that are currently marked as shutting down This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.

@option arguments [String] :node_id Which node for which to retrieve the shutdown status @option arguments [Hash] :headers Custom HTTP headers

@see www.elastic.co/guide/en/elasticsearch/reference/current

# File lib/elasticsearch/api/actions/shutdown/get_node.rb, line 33
def get_node(arguments = {})
  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  _node_id = arguments.delete(:node_id)

  method = Elasticsearch::API::HTTP_GET
  path   = if _node_id
             "_nodes/#{Utils.__listify(_node_id)}/shutdown"
           else
             "_nodes/shutdown"
           end
  params = {}

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

Adds a node to be shut down This functionality is Experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.

@option arguments [String] :node_id The node id of node to be shut down @option arguments [Hash] :headers Custom HTTP headers @option arguments [Hash] :body The shutdown type definition to register (Required)

@see www.elastic.co/guide/en/elasticsearch/reference/current

# File lib/elasticsearch/api/actions/shutdown/put_node.rb, line 34
def put_node(arguments = {})
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
  raise ArgumentError, "Required argument 'node_id' missing" unless arguments[:node_id]

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

  arguments = arguments.clone

  _node_id = arguments.delete(:node_id)

  method = Elasticsearch::API::HTTP_PUT
  path   = "_nodes/#{Utils.__listify(_node_id)}/shutdown"
  params = {}

  body = arguments[:body]
  perform_request(method, path, params, body, headers).body
end