Stops a started data frame transform.
It accepts a
StopDataFrameTransformRequest object and responds with a
StopDataFrameTransformRequest object requires a non-null
id can be a comma separated
list of IDs or a single ID. Wildcards,
_all are also accepted.
The following arguments are optional.
When executing a
StopDataFrameTransformRequest in the following manner, the client waits
StopDataFrameTransformResponse to be returned before continuing with code execution:
StopDataFrameTransformResponse response = client.dataFrame().stopDataFrameTransform( request, RequestOptions.DEFAULT);
Synchronous calls may throw an
IOException in case of either failing to
parse the REST response in the high-level REST client, the request times out
or similar cases where there is no response coming back from the server.
In cases where the server returns a
5xx error code, the high-level
client tries to parse the response body error details instead and then throws
ElasticsearchException and adds the original
ResponseException as a
suppressed exception to it.
StopDataFrameTransformRequest can also be done in an asynchronous fashion so that
the client can return directly. Users need to specify how the response or
potential failures will be handled by passing the request and a listener to the
asynchronous stop-data-frame-transform method:
The asynchronous method does not block and returns immediately. Once it is
ActionListener is called back using the
if the execution successfully completed or using the
onFailure method if
it failed. Failure scenarios and expected exceptions are the same as in the
synchronous execution case.
A typical listener for
stop-data-frame-transform looks like:
StopDataFrameTransformResponse object acknowledges the data frame transform has stopped.