Contents

# Licensed to Elasticsearch B.V. under one or more contributor
# license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright
# ownership. Elasticsearch B.V. licenses this file to you under
# the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.

module Elasticsearch
  module API
    module Shutdown
      module Actions
        # Adds a node to be shut down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.
        #
        # @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 https://www.elastic.co/guide/en/elasticsearch/reference/current
        #
        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) || {}

          body = arguments.delete(:body)

          arguments = arguments.clone

          _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
      end
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
elasticsearch-api-8.1.0	lib/elasticsearch/api/actions/shutdown/put_node.rb
elasticsearch-api-8.0.0	lib/elasticsearch/api/actions/shutdown/put_node.rb
elasticsearch-api-8.0.0.pre1	lib/elasticsearch/api/actions/shutdown/put_node.rb