Module: Elasticsearch::API::Shutdown::Actions

Included in:
ShutdownClient
Defined in:
lib/elasticsearch/api/namespace/shutdown.rb,
lib/elasticsearch/api/actions/shutdown/get_node.rb,
lib/elasticsearch/api/actions/shutdown/put_node.rb,
lib/elasticsearch/api/actions/shutdown/delete_node.rb

Instance Method Summary collapse

Instance Method Details

#delete_node(arguments = {}) ⇒ Object

Removes a node from the shutdown list. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :node_id (String) —

    The node id of node to be removed from the shutdown state

  • :headers (Hash) —

    Custom HTTP headers

Raises:

  • (ArgumentError)

See Also:


32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/elasticsearch/api/actions/shutdown/delete_node.rb', line 32

def delete_node(arguments = {})
  raise ArgumentError, "Required argument 'node_id' missing" unless arguments[:node_id]

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

  body = nil

  _node_id = arguments.delete(:node_id)

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

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

#get_node(arguments = {}) ⇒ Object

Retrieve status of a node or nodes that are currently marked as shutting down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :node_id (String) —

    Which node for which to retrieve the shutdown status

  • :headers (Hash) —

    Custom HTTP headers

See Also:


32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/elasticsearch/api/actions/shutdown/get_node.rb', line 32

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

  body = nil

  _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 = {}

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

#put_node(arguments = {}) ⇒ Object

Adds a node to be shut down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.

Parameters:

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

    a customizable set of options

Options Hash (arguments):

  • :node_id (String) —

    The node id of node to be shut down

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    The shutdown type definition to register (Required)

Raises:

  • (ArgumentError)

See Also:


33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/elasticsearch/api/actions/shutdown/put_node.rb', line 33

def put_node(arguments = {})
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
  raise ArgumentError, "Required argument 'node_id' missing" unless arguments[:node_id]

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

  body = arguments.delete(:body)

  _node_id = arguments.delete(:node_id)

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

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