28 lines
923 B
Plaintext
28 lines
923 B
Plaintext
|
--
|
||
|
|
:api: stop-data-frame-analytics
|
||
|
|
:request: StopDataFrameAnalyticsRequest
|
||
|
|
:response: StopDataFrameAnalyticsResponse
|
||
|
|
--
|
||
|
|
[id="{upid}-{api}"]
|
||
|
|
=== Stop Data Frame Analytics API
|
||
|
|
|
||
|
|
The Stop Data Frame Analytics API is used to stop a running {dataframe-analytics-config}.
|
||
|
|
It accepts a +{request}+ object and responds with a +{response}+ object.
|
||
|
|
|
||
|
|
[id="{upid}-{api}-request"]
|
||
|
|
==== Stop Data Frame Analytics Request
|
||
|
|
|
||
|
|
A +{request}+ object requires a {dataframe-analytics-config} id.
|
||
|
|
|
||
|
|
["source","java",subs="attributes,callouts,macros"]
|
||
|
|
---------------------------------------------------
|
||
|
|
include-tagged::{doc-tests-file}[{api}-request]
|
||
|
|
---------------------------------------------------
|
||
|
|
<1> Constructing a new stop request referencing an existing {dataframe-analytics-config}
|
||
|
|
|
||
|
|
include::../execution.asciidoc[]
|
||
|
|
|
||
|
|
[id="{upid}-{api}-response"]
|
||
|
|
==== Response
|
||
|
|
|
||
|
|
The returned +{response}+ object acknowledges the {dataframe-job} has stopped.
|