stop-transform.asciidoc 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. [role="xpack"]
  2. [testenv="basic"]
  3. [[stop-data-frame-transform]]
  4. === Stop {dataframe-transforms} API
  5. ++++
  6. <titleabbrev>Stop {dataframe-transforms}</titleabbrev>
  7. ++++
  8. Stops one or more {dataframe-transforms}.
  9. ==== Request
  10. `POST _data_frame/transforms/<data_frame_transform_id>/_stop`
  11. //==== Description
  12. ==== Path Parameters
  13. `data_frame_transform_id` (required)::
  14. (string) Identifier for the {dataframe-transform}. This identifier can contain
  15. lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It
  16. must start and end with alphanumeric characters.
  17. ==== Query Parameters
  18. `wait_for_completion`::
  19. (boolean) If set to true, causes the API to block until the indexer state completely stops. If set to false, the API returns immediately and the indexer will be stopped asynchronously in the background. Defaults to `false`.
  20. `timeout`::
  21. (time value) If `wait_for_completion=true`, the API blocks for (at maximum)
  22. the specified duration while waiting for the job to stop. If more than
  23. `timeout` time has passed, the API throws a timeout exception. Even if a
  24. timeout exception is thrown, the stop request is still processing and
  25. eventually moves the job to `STOPPED`. The timeout simply means the API call itself timed out while waiting for the status change. Defaults to `30s`
  26. //==== Request Body
  27. //==== Authorization
  28. ==== Examples
  29. The following example stops the `ecommerce_transform` {dataframe-transform}:
  30. [source,js]
  31. --------------------------------------------------
  32. POST _data_frame/transforms/ecommerce_transform/_stop
  33. --------------------------------------------------
  34. // CONSOLE
  35. // TEST[skip:set up kibana samples]
  36. When the {dataframe-transform} stops, you receive the following results:
  37. [source,js]
  38. ----
  39. {
  40. "stopped" : true
  41. }
  42. ----
  43. // TESTRESPONSE