WARNING: Deprecated in 7.15.0.
The Java REST Client is deprecated in favor of the Java API Client.
Updates an existing transform.
The API accepts a
UpdateTransformRequest object as a request and returns a
UpdateTransformRequest requires the following argument:
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
TransformConfigUpdate object contains all the details about updated
transform configuration and contains the following arguments:
TransformConfigUpdate update = TransformConfigUpdate .builder() .setSource(SourceConfig.builder() .setIndex("source-data") .build()) .setDest(DestConfig.builder() .setIndex("pivot-dest") .build()) .setFrequency(TimeValue.timeValueSeconds(15)) .setSyncConfig(TimeSyncConfig.builder() .setField("time-field") .setDelay(TimeValue.timeValueSeconds(120)) .build()) .setDescription("This is my updated transform") .setRetentionPolicyConfig(TimeRetentionPolicyConfig.builder() .setField("time-field") .setMaxAge(TimeValue.timeValueDays(30)) .build()) .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.
Optional retention policy for the data in the destination index
When executing a
UpdateTransformRequest in the following manner, the client waits
UpdateTransformResponse to be returned before continuing with code execution:
UpdateTransformResponse response = client.transform().updateTransform(request, RequestOptions.DEFAULT); TransformConfig 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
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.
UpdateTransformRequest 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:
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
update-transform looks like:
UpdateTransformResponse contains the updated transform configuration
or an error if the update failed or is invalid.