Sha256: 7e05a22910ea721c8183af1cb327f91c44cde8614eb52f1532e534ba07e900a7

Contents?: true

Size: 1.4 KB

Versions: 7

Compression:

Stored size: 1.4 KB

Contents

module Elasticsearch
  module XPack
    module API
      module MachineLearning
        module Actions

          # Start a datafeed
          #
          # @option arguments [String] :datafeed_id The ID of the datafeed to start (*Required*)
          # @option arguments [Hash] :body The start datafeed parameters
          # @option arguments [String] :start The start time from where the datafeed should begin
          # @option arguments [String] :end The end time when the datafeed should stop. When not set, the datafeed continues in real time
          # @option arguments [Time] :timeout Controls the time to wait until a datafeed has started. Default to 20 seconds
          #
          # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html
          #
          def start_datafeed(arguments={})
            raise ArgumentError, "Required argument 'datafeed_id' missing" unless arguments[:datafeed_id]

            valid_params = [
              :start,
              :end,
              :timeout ]

            method = Elasticsearch::API::HTTP_POST
            path   = "_xpack/ml/datafeeds/#{arguments[:datafeed_id]}/_start"
            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
            body   = arguments[:body]

            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/start_datafeed.rb
elasticsearch-xpack-6.8.0 lib/elasticsearch/xpack/api/actions/machine_learning/start_datafeed.rb
elasticsearch-xpack-6.3.1 lib/elasticsearch/xpack/api/actions/machine_learning/start_datafeed.rb
elasticsearch-xpack-6.3.0 lib/elasticsearch/xpack/api/actions/machine_learning/start_datafeed.rb
elasticsearch-xpack-6.2.0 lib/elasticsearch/xpack/api/actions/machine_learning/start_datafeed.rb
elasticsearch-xpack-6.1.0 lib/elasticsearch/xpack/api/actions/machine_learning/start_datafeed.rb
elasticsearch-xpack-6.0.0 lib/elasticsearch/xpack/api/actions/machine_learning/start_datafeed.rb