lib/elasticsearch/xpack/api/actions/machine_learning/start_datafeed.rb in elasticsearch-xpack-5.5.0 vs lib/elasticsearch/xpack/api/actions/machine_learning/start_datafeed.rb in elasticsearch-xpack-6.0.0
- old
+ new
@@ -2,25 +2,27 @@
module XPack
module API
module MachineLearning
module Actions
- # TODO: Description
+ # 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/x-pack/current/ml-start-datafeed.html
+ # @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]