Sha256: fc342fed630a7dbc2cb03acec332dfaf30e314d2414346e036c33fa1d8ebf870

Contents?: true

Size: 1.38 KB

Versions: 7

Compression:

Stored size: 1.38 KB

Contents

module Elasticsearch
  module XPack
    module API
      module MachineLearning
        module Actions

          # Stop a datafeed
          #
          # @option arguments [String] :datafeed_id The ID of the datafeed to stop (*Required*)
          # @option arguments [Boolean] :allow_no_datafeeds Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)
          # @option arguments [Boolean] :force True if the datafeed should be forcefully stopped.
          # @option arguments [Time] :timeout Controls the time to wait until a datafeed has stopped. Default to 20 seconds
          #
          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html
          #
          def stop_datafeed(arguments={})
            raise ArgumentError, "Required argument 'datafeed_id' missing" unless arguments[:datafeed_id]
            valid_params = [
              :allow_no_datafeeds,
              :force,
              :timeout ]
            method = Elasticsearch::API::HTTP_POST
            path   = "_xpack/ml/datafeeds/#{arguments[:datafeed_id]}/_stop"
            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
            body   = nil

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

Version data entries

7 entries across 7 versions & 1 rubygems

Version Path
elasticsearch-xpack-6.8.1 lib/elasticsearch/xpack/api/actions/machine_learning/stop_datafeed.rb
elasticsearch-xpack-6.8.0 lib/elasticsearch/xpack/api/actions/machine_learning/stop_datafeed.rb
elasticsearch-xpack-6.3.1 lib/elasticsearch/xpack/api/actions/machine_learning/stop_datafeed.rb
elasticsearch-xpack-6.3.0 lib/elasticsearch/xpack/api/actions/machine_learning/stop_datafeed.rb
elasticsearch-xpack-6.2.0 lib/elasticsearch/xpack/api/actions/machine_learning/stop_datafeed.rb
elasticsearch-xpack-6.1.0 lib/elasticsearch/xpack/api/actions/machine_learning/stop_datafeed.rb
elasticsearch-xpack-6.0.0 lib/elasticsearch/xpack/api/actions/machine_learning/stop_datafeed.rb