start-data-frame-analytics.asciidoc 922 B

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