Stop data frame transform APIedit

Stops a started data frame transform. It accepts a StopDataFrameTransformRequest object and responds with a StopDataFrameTransformResponse object.

Stop data frame transform requestedit

A StopDataFrameTransformRequest object requires a non-null id. id can be a comma separated list of IDs or a single ID. Wildcards, * and _all are also accepted.

StopDataFrameTransformRequest request =
        new StopDataFrameTransformRequest("mega-transform"); 

Constructing a new stop request referencing an existing data frame transform

Optional argumentsedit

The following arguments are optional.

request.setWaitForCompletion(Boolean.TRUE);  
request.setTimeout(TimeValue.timeValueSeconds(30));  
request.setAllowNoMatch(true); 

If true wait for the data frame task to stop before responding

Controls the amount of time to wait until the data frame transform stops.

Whether to ignore if a wildcard expression matches no transforms.

Synchronous executionedit

When executing a StopDataFrameTransformRequest in the following manner, the client waits for the 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 4xx or 5xx error code, the high-level client tries to parse the response body error details instead and then throws a generic ElasticsearchException and adds the original ResponseException as a suppressed exception to it.

Asynchronous executionedit

Executing a 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:

client.dataFrame().stopDataFrameTransformAsync(
        request, RequestOptions.DEFAULT, listener); 

The StopDataFrameTransformRequest to execute and the ActionListener to use when the execution completes

The asynchronous method does not block and returns immediately. Once it is completed the ActionListener is called back using the onResponse method 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:

ActionListener<StopDataFrameTransformResponse> listener =
        new ActionListener<StopDataFrameTransformResponse>() {
            @Override
            public void onResponse(
                    StopDataFrameTransformResponse response) {
                
            }

            @Override
            public void onFailure(Exception e) {
                
            }
        };

Called when the execution is successfully completed.

Called when the whole StopDataFrameTransformRequest fails.

Responseedit

The returned StopDataFrameTransformResponse object acknowledges the data frame transform has stopped.