[API] Adds machine_learning.reset_job

Author: picandocodigo

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/reset_job.rb

@@ -0,0 +1,59 @@
+# 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 XPack
+    module API
+      module MachineLearning
+        module Actions
+          # Resets an existing anomaly detection job.
+          #
+          # @option arguments [String] :job_id The ID of the job to reset
+          # @option arguments [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning
+          # @option arguments [Hash] :headers Custom HTTP headers
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-reset-job.html
+          #
+          def reset_job(arguments = {})
+            raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
+
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+
+            _job_id = arguments.delete(:job_id)
+
+            method = Elasticsearch::API::HTTP_POST
+            path   = "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}/_reset"
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments,
+                                                                             ParamsRegistry.get(__method__)
+
+            body = nil
+            perform_request(method, path, params, body, headers).body
+          end
+
+          # Register this action with its valid params when the module is loaded.
+          #
+          # @since 6.2.0
+          ParamsRegistry.register(:reset_job, [
+            :wait_for_completion
+          ].freeze)
+        end
+      end
+    end
+  end
+end

elasticsearch-xpack/spec/xpack/machine_learning/reset_job_spec.rb

@@ -0,0 +1,46 @@
+# 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#ml.reset_job' do
+  let(:expected_args) do
+    [
+      'POST',
+      '_ml/anomaly_detectors/foo/_reset',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.ml.reset_job(job_id: 'foo')).to eq({})
+  end
+
+  let(:client) do
+    Class.new { include Elasticsearch::XPack::API }.new
+  end
+
+  context 'when a job_id is not provided' do
+    it 'raises an exception' do
+      expect {
+        client.ml.reset_job
+      }.to raise_exception(ArgumentError)
+    end
+  end
+end