Contents

# Licensed to Elasticsearch B.V under one or more agreements.
# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
# See the LICENSE file in the project root for more information

module Elasticsearch
  module XPack
    module API
      module MachineLearning
        module Actions

          # Delete an existing model snapshot
          #
          # @option arguments [String] :job_id The ID of the job to fetch (*Required*)
          # @option arguments [String] :snapshot_id The ID of the snapshot to delete (*Required*)
          #
          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapshot.html
          #
          def delete_model_snapshot(arguments={})
            raise ArgumentError, "Required argument 'job_id' missing" unless arguments[:job_id]
            raise ArgumentError, "Required argument 'snapshot_id' missing" unless arguments[:snapshot_id]
            method = Elasticsearch::API::HTTP_DELETE
            path   = "_xpack/ml/anomaly_detectors/#{arguments[:job_id]}/model_snapshots/#{arguments[:snapshot_id]}"
            params = {}
            body   = nil

            perform_request(method, path, params, body).body
          end
        end
      end
    end
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
elasticsearch-xpack-6.8.3	lib/elasticsearch/xpack/api/actions/machine_learning/delete_model_snapshot.rb
elasticsearch-xpack-6.8.2	lib/elasticsearch/xpack/api/actions/machine_learning/delete_model_snapshot.rb
elasticsearch-xpack-7.4.0	lib/elasticsearch/xpack/api/actions/machine_learning/delete_model_snapshot.rb
elasticsearch-xpack-7.3.0	lib/elasticsearch/xpack/api/actions/machine_learning/delete_model_snapshot.rb