Creates a new transform.
The API accepts a
PutTransformRequest object as a request and returns a
PutTransformRequest requires the following argument:
The configuration of the transform to create
Whether or not to wait to run deferrable validations until
TransformConfig object contains all the details about the
transform configuration and contains the following arguments:
TransformConfig transformConfig = TransformConfig .builder() .setId("reviewer-avg-rating") .setSource(sourceConfig) .setDest(destConfig) .setFrequency(TimeValue.timeValueSeconds(15)) .setPivotConfig(pivotConfig) .setDescription("This is my test transform") .setSettings(settings) .setRetentionPolicyConfig(retentionPolicy) .setSyncConfig(syncConfig) .build();
The transform ID
The source indices and query from which to gather data
The destination index and optional pipeline
Optional, indicates how often to check for updates to the source indices
Optional free text description of the transform
Optional transform settings
Optional retention policy for the data in the destination index
Details required only when the transform runs continuously
The indices and the query from which to collect data.
If query is not set, a
match_all query is used by default.
SourceConfig sourceConfig = SourceConfig.builder() .setIndex("source-index") .setQueryConfig(queryConfig).build();
The index where to write the data and the optional pipeline through which the docs should be indexed
DestConfig destConfig = DestConfig.builder() .setIndex("pivot-destination") .setPipeline("my-pipeline").build();
The query with which to select data from the source.
QueryConfig queryConfig = new QueryConfig(new MatchAllQueryBuilder());
Defines the pivot function
group by fields and the aggregation to reduce the data.
The grouping terms. Defines the group by and destination fields which are produced by the pivot function. There are 3 types of groups
- Date Histogram
Defines the aggregations for the group fields.
Defines a retention policy for the transform. Data that meets the defined criteria is deleted from the destination index.
Defines the properties transforms require to run continuously.
When executing a
PutTransformRequest in the following manner, the client waits
AcknowledgedResponse to be returned before continuing with code execution:
AcknowledgedResponse response = client.transform().putTransform( 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.
PutTransformRequest 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 put-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
put-transform looks like:
AcknowledgedResponse acknowledges the successful creation of
the new transform or an error if the configuration is invalid.