schedule-now-transform.asciidoc 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. [role="xpack"]
  2. [testenv="basic"]
  3. [[schedule-now-transform]]
  4. = Schedule now {transform} API
  5. [subs="attributes"]
  6. ++++
  7. <titleabbrev>Schedule now {transform}</titleabbrev>
  8. ++++
  9. Instantly runs a {transform} to process data.
  10. [[schedule-now-transform-request]]
  11. == {api-request-title}
  12. `POST _transform/<transform_id>/_schedule_now`
  13. [[schedule-now-transform-prereqs]]
  14. == {api-prereq-title}
  15. * Requires the `manage_transform` cluster privilege. This privilege is included
  16. in the `transform_admin` built-in role.
  17. [schedule-now-transform-desc]]
  18. == {api-description-title}
  19. When you run this API, the {transform} processes the new data instantly,
  20. without waiting for the configured `frequency` interval.
  21. Subsequently, the transform will be processed again at
  22. `now + frequency` unless the API is called again in the meantime.
  23. [[schedule-now-transform-path-parms]]
  24. == {api-path-parms-title}
  25. `<transform_id>`::
  26. (Required, string)
  27. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-id]
  28. [[schedule-now-transform-query-parms]]
  29. == {api-query-parms-title}
  30. `timeout`::
  31. (Optional, time)
  32. Period to wait for a response. If no response is received before the timeout
  33. expires, the request fails and returns an error. Defaults to `30s`.
  34. [[schedule-now-transform-examples]]
  35. == {api-examples-title}
  36. [source,console]
  37. --------------------------------------------------
  38. POST _transform/ecommerce_transform/_schedule_now
  39. --------------------------------------------------
  40. // TEST[skip:setup kibana sample data]
  41. When the {transform} is scheduled now, you receive the following results:
  42. [source,console-result]
  43. ----
  44. {
  45. "acknowledged" : true
  46. }
  47. ----