[API] Adds nodes.clear_metering_archive

Author: picandocodigo

elasticsearch-api/lib/elasticsearch/api/actions/nodes/clear_metering_archive.rb

@@ -0,0 +1,58 @@
+# 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 Nodes
+      module Actions
+        # Removes the archived repositories metering information present in the cluster.
+        # 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 [List] :node_id Comma-separated list of node IDs or names used to limit returned information.
+        # @option arguments [Long] :max_archive_version Specifies the maximum archive_version to be cleared from the archive.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/clear-repositories-metering-archive-api.html
+        #
+        def clear_metering_archive(arguments = {})
+          raise ArgumentError, "Required argument 'node_id' missing" unless arguments[:node_id]
+
+          raise ArgumentError,
+                "Required argument 'max_archive_version' missing" unless arguments[:max_archive_version]
+
+          headers = arguments.delete(:headers) || {}
+
+          arguments = arguments.clone
+
+          _node_id = arguments.delete(:node_id)
+
+          _max_archive_version = arguments.delete(:max_archive_version)
+
+          method = Elasticsearch::API::HTTP_DELETE
+          path   = "_nodes/#{Utils.__listify(_node_id)}/_repositories_metering/#{Utils.__listify(_max_archive_version)}"
+          params = {}
+
+          body = nil
+          perform_request(method, path, params, body, headers).body
+        end
+      end
+    end
+  end
+end

elasticsearch-api/spec/elasticsearch/api/actions/nodes/clear_metering_archive_spec.rb

@@ -0,0 +1,50 @@
+# 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.
+
+require 'spec_helper'
+
+describe 'client.nodes#clear_metering_archive' do
+  let(:expected_args) do
+    [
+      'DELETE',
+      '_nodes/foo/_repositories_metering/bar',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.nodes.clear_metering_archive(node_id: 'foo', max_archive_version: 'bar')).to eq({})
+  end
+
+  let(:client) do
+    Class.new { include Elasticsearch::API }.new
+  end
+
+  it 'raises an error if no node_id is provided' do
+    expect do
+      client.nodes.clear_metering_archive(max_archive_version: 'bar')
+    end.to raise_exception(ArgumentError)
+  end
+
+  it 'raises an error if no max_archive_version is provided' do
+    expect do
+      client.nodes.clear_metering_archive(node_id: 'foo')
+    end.to raise_exception(ArgumentError)
+  end
+end