Creates a new transform.
The API accepts a
PutDataFrameTransformRequest object as a request and returns a
PutDataFrameTransformRequest requires the following argument:
The configuration of the transform to create
Whether or not to wait to run deferrable validations until
DataFrameTransformConfig object contains all the details about the
transform configuration and contains the following arguments:
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 aggregations to use
The maximum paging size for the transform when pulling data from the source. The size dynamically adjusts as the transform is running to recover from and prevent OOM issues.
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.
When executing a
PutDataFrameTransformRequest in the following manner, the client waits
AcknowledgedResponse to be returned before continuing with code execution:
AcknowledgedResponse response = client.dataFrame().putDataFrameTransform( 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.
PutDataFrameTransformRequest 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.