lib/elasticsearch/xpack/api/actions/machine_learning/start_datafeed.rb in elasticsearch-xpack-7.6.0 vs lib/elasticsearch/xpack/api/actions/machine_learning/start_datafeed.rb in elasticsearch-xpack-7.7.0.pre
- old
+ new
@@ -5,34 +5,35 @@
module Elasticsearch
module XPack
module API
module MachineLearning
module Actions
- # TODO: Description
-
+ # Starts one or more datafeeds.
#
# @option arguments [String] :datafeed_id The ID of the datafeed to start
# @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
-
+ # @option arguments [Hash] :headers Custom HTTP headers
# @option arguments [Hash] :body The start datafeed parameters
#
- # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html
+ # @see https://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]
+ headers = arguments.delete(:headers) || {}
+
arguments = arguments.clone
_datafeed_id = arguments.delete(:datafeed_id)
method = Elasticsearch::API::HTTP_POST
path = "_ml/datafeeds/#{Elasticsearch::API::Utils.__listify(_datafeed_id)}/_start"
params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
body = arguments[:body]
- perform_request(method, path, params, body).body
+ perform_request(method, path, params, body, headers).body
end
# Register this action with its valid params when the module is loaded.
#
# @since 6.2.0