Method: Elasticsearch::API::MachineLearning::Actions#stop_datafeed

Defined in:
lib/elasticsearch/api/actions/machine_learning/stop_datafeed.rb

#stop_datafeed(arguments = {}) ⇒ Object

Stops one or more datafeeds.

Options Hash (arguments):

  • :datafeed_id (String) —

    The ID of the datafeed to stop

  • :allow_no_match (Boolean) —

    Whether to ignore if a wildcard expression matches no datafeeds. (This includes _all string or when no datafeeds have been specified)

  • :allow_no_datafeeds (Boolean) —

    Whether to ignore if a wildcard expression matches no datafeeds. (This includes _all string or when no datafeeds have been specified) Deprecated

  • :force (Boolean) —

    True if the datafeed should be forcefully stopped.

  • :timeout (Time) —

    Controls the time to wait until a datafeed has stopped. Default to 20 seconds

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    The URL params optionally sent in the body

Raises:

  • (ArgumentError)

See Also:



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/elasticsearch/api/actions/machine_learning/stop_datafeed.rb', line 37

def stop_datafeed(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || "ml.stop_datafeed" }

  defined_params = [:datafeed_id].inject({}) do |set_variables, variable|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
    set_variables
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'datafeed_id' missing" unless arguments[:datafeed_id]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = arguments.delete(:body)

  _datafeed_id = arguments.delete(:datafeed_id)

  method = Elasticsearch::API::HTTP_POST
  path   = "_ml/datafeeds/#{Utils.__listify(_datafeed_id)}/_stop"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end