Module: OpenSearch::API::Shutdown::Actions

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

Defined Under Namespace

Modules: ParamsRegistry

Instance Method Summary collapse

Instance Method Details

#delete_node(arguments = {}) ⇒ Object

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

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) 


41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/opensearch/api/actions/shutdown/delete_node.rb', line 41

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 = OpenSearch::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 = {}) ⇒ Object

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. OpenSearch will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.

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



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/opensearch/api/actions/shutdown/get_node.rb', line 41

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

  arguments = arguments.clone

  _node_id = arguments.delete(:node_id)

  method = OpenSearch::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 = {}) ⇒ Object

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

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) 


42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/opensearch/api/actions/shutdown/put_node.rb', line 42

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 = OpenSearch::API::HTTP_PUT
  path   = "_nodes/#{Utils.__listify(_node_id)}/shutdown"
  params = {}

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