[XPACK] Adds ml.get_model_snapshot_upgrade_stats

Author: picandocodigo

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

@@ -0,0 +1,62 @@
+# 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
+          # Gets stats for anomaly detection job model snapshot upgrades that are in progress.
+          #
+          # @option arguments [String] :job_id The ID of the job. May be a wildcard, comma separated list or `_all`.
+          # @option arguments [String] :snapshot_id The ID of the snapshot. May be a wildcard, comma separated list or `_all`.
+          # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no jobs or no snapshots. (This includes the `_all` string.)
+          # @option arguments [Hash] :headers Custom HTTP headers
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.16/ml-get-job-model-snapshot-upgrade-stats.html
+          #
+          def get_model_snapshot_upgrade_stats(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_GET
+            path   = "_ml/anomaly_detectors/#{Elasticsearch::API::Utils.__listify(_job_id)}/model_snapshots/#{Elasticsearch::API::Utils.__listify(_snapshot_id)}/_upgrade/_stats"
+            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(:get_model_snapshot_upgrade_stats, [
+            :allow_no_match
+          ].freeze)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# 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.get_model_snapshot_upgrade_stats' do
+  let(:expected_args) do
+    [
+      'GET',
+      '_ml/anomaly_detectors/foo/model_snapshots/bar/_upgrade/_stats',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(
+      client_double.machine_learning.get_model_snapshot_upgrade_stats(job_id: 'foo', snapshot_id: 'bar')
+    ).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.machine_learning.get_model_snapshot_upgrade_stats(snapshot_id: 'foo')
+      }.to raise_exception(ArgumentError)
+    end
+  end
+
+  context 'when a snapshot_id is not provided' do
+    it 'raises an exception' do
+      expect {
+        client.machine_learning.get_model_snapshot_upgrade_stats(job_id: 'foo')
+      }.to raise_exception(ArgumentError)
+    end
+  end
+end