Contents

# 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

           # Temporarily halt tasks associated with the jobs and datafeeds and prevent new jobs from opening.
          # When enabled=true this API temporarily halts all job and datafeed tasks and prohibits new job and
          #   datafeed tasks from starting.
          #
          # @option arguments [ true, false ] :enabled Whether to enable upgrade_mode ML setting or not. Defaults to false.
          # @option arguments [String] :timeout Controls the time to wait before action times out. Defaults to 30 seconds.
          #
          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-set-upgrade-mode.html
          #
          def set_upgrade_mode(arguments={})

             valid_params = [
                :enabled,
                :timeout ]

             method = Elasticsearch::API::HTTP_POST
            path   = '_ml/set_upgrade_mode'
            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params

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

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
elasticsearch-xpack-6.8.1	lib/elasticsearch/xpack/api/actions/machine_learning/set_upgrade_mode.rb
elasticsearch-xpack-6.8.0	lib/elasticsearch/xpack/api/actions/machine_learning/set_upgrade_mode.rb
elasticsearch-xpack-6.3.1	lib/elasticsearch/xpack/api/actions/machine_learning/set_upgrade_mode.rb
elasticsearch-xpack-6.3.0	lib/elasticsearch/xpack/api/actions/machine_learning/set_upgrade_mode.rb