[XPACK] Adds ml.upgrade_job_snapshot

Author: picandocodigo

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

@@ -0,0 +1,64 @@
+# 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
+          # Upgrades a given job snapshot to the current major version.
+          #
+          # @option arguments [String] :job_id The ID of the job
+          # @option arguments [String] :snapshot_id The ID of the snapshot
+          # @option arguments [Time] :timeout How long should the API wait for the job to be opened and the old snapshot to be loaded.
+          # @option arguments [Boolean] :wait_for_completion Should the request wait until the task is complete before responding to the caller. Default is false.
+          # @option arguments [Hash] :headers Custom HTTP headers
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-upgrade-job-model-snapshot.html
+          #
+          def upgrade_job_snapshot(arguments = {})
+            raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
+            raise ArgumentError, "Required argument 'snapshot_id' missing" unless arguments[:snapshot_id]
+
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+
+            _job_id = arguments.delete(:job_id)
+
+            _snapshot_id = arguments.delete(:snapshot_id)
+
+            method = Elasticsearch::API::HTTP_POST
+            path   = "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}/model_snapshots/#{Elasticsearch::API::Utils.__listify(_snapshot_id)}/_upgrade"
+            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(:upgrade_job_snapshot, [
+            :timeout,
+            :wait_for_completion
+          ].freeze)
+        end
+      end
+    end
+  end
+end

elasticsearch-xpack/test/unit/machine_learning/upgrade_job_snapshot_test.rb

@@ -0,0 +1,43 @@
+# 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 'test_helper'
+
+module Elasticsearch
+  module Test
+    class XPackMlUpdateJobSnapshotTest < Minitest::Test
+
+      context "XPack MachineLearning: Upgrade job snapshot" do
+        subject { FakeClient.new }
+
+        should "perform correct request" do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal 'POST', method
+            assert_equal "_ml/anomaly_detectors/foo/model_snapshots/bar/_upgrade", url
+            assert_equal Hash.new, params
+            assert_equal nil, body
+            true
+          end.returns(FakeResponse.new)
+
+          subject.xpack.ml.upgrade_job_snapshot(job_id: 'foo', snapshot_id: 'bar')
+        end
+
+      end
+
+    end
+  end
+end