start-data-frame-analytics.asciidoc 856 B

1234567891011121314151617181920212223242526272829
  1. --
  2. :api: start-data-frame-analytics
  3. :request: StartDataFrameAnalyticsRequest
  4. :response: AcknowledgedResponse
  5. --
  6. [role="xpack"]
  7. [id="{upid}-{api}"]
  8. === Start {dfanalytics-jobs} API
  9. Starts an existing {dfanalytics-job}.
  10. It accepts a +{request}+ object and responds with a +{response}+ object.
  11. [id="{upid}-{api}-request"]
  12. ==== Start {dfanalytics-job} request
  13. A +{request}+ object requires a {dfanalytics-job} ID.
  14. ["source","java",subs="attributes,callouts,macros"]
  15. ---------------------------------------------------
  16. include-tagged::{doc-tests-file}[{api}-request]
  17. ---------------------------------------------------
  18. <1> Constructing a new start request referencing an existing {dfanalytics-job}
  19. include::../execution.asciidoc[]
  20. [id="{upid}-{api}-response"]
  21. ==== Response
  22. The returned +{response}+ object acknowledges the {dfanalytics-job} has started.