IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Put transform API Delete transform API »

› › ›

Update transform API

edit

Update transform API

edit

Updates an existing transform.

The API accepts a UpdateDataFrameTransformRequest object as a request and returns a UpdateDataFrameTransformResponse.

Update transform request

edit

A UpdateDataFrameTransformRequest requires the following argument:

UpdateDataFrameTransformRequest request =
    new UpdateDataFrameTransformRequest(
        update, 
        "my-transform-to-update"); 
request.setDeferValidation(false);

	The update configuration with which to update the transform.
	The ID of the configuration to update.
	Whether or not to wait to run deferrable validations until `_start` is called. This option should be used with care as the created transform will run with the privileges of the user creating it. Meaning, if they do not have privileges, such an error will not be visible until `_start` is called.

Transform update configuration

edit

The DataFrameTransformConfigUpdate object contains all the details about updated transform configuration and contains the following arguments:

DataFrameTransformConfigUpdate update = DataFrameTransformConfigUpdate
    .builder()
    .setSource(SourceConfig.builder()
        .setIndex("source-data")
        .build()) 
    .setDest(DestConfig.builder()
        .setIndex("pivot-dest")
        .build()) 
    .setFrequency(TimeValue.timeValueSeconds(15)) 
    .setSyncConfig(new TimeSyncConfig("time-field",
        TimeValue.timeValueSeconds(120))) 
    .setDescription("This is my updated transform") 
    .build();

	The source indices and query from which to gather data.
	The destination index and optional pipeline.
	How often to check for updates to the source indices.
	How to keep the transform in sync with incoming data.
	Optional free text description of the transform.

Synchronous execution

edit

When executing a UpdateDataFrameTransformRequest in the following manner, the client waits for the UpdateDataFrameTransformResponse to be returned before continuing with code execution:

UpdateDataFrameTransformResponse response =
    client.dataFrame().updateDataFrameTransform(request,
        RequestOptions.DEFAULT);
DataFrameTransformConfig updatedConfig =
    response.getTransformConfiguration();

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 execution

edit

Executing a UpdateDataFrameTransformRequest 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 update-transform method:

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

The UpdateDataFrameTransformRequest 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 update-transform looks like:

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

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

	Called when the execution is successfully completed.
	Called when the whole `UpdateDataFrameTransformRequest` fails.

Response

edit

The returned UpdateDataFrameTransformResponse contains the updated transform configuration or an error if the update failed or is invalid.

« Put transform API Delete transform API »