- Java REST Client (deprecated): other versions:
- Overview
- Java Low Level REST Client
- Java High Level REST Client
- Getting started
- Document APIs
- Search APIs
- Async Search APIs
- Miscellaneous APIs
- Index APIs
- Analyze API
- Create Index API
- Delete Index API
- Index Exists API
- Open Index API
- Close Index API
- Shrink Index API
- Split Index API
- Clone Index API
- Refresh API
- Flush API
- Flush Synced API
- Clear Cache API
- Force Merge API
- Rollover Index API
- Update mapping API
- Get Mappings API
- Get Field Mappings API
- Index Aliases API
- Delete Alias API
- Exists Alias API
- Get Alias API
- Update Indices Settings API
- Get Settings API
- Create or update index template API
- Validate Query API
- Get Templates API
- Templates Exist API
- Get Index API
- Freeze Index API
- Unfreeze Index API
- Delete Template API
- Reload Search Analyzers API
- Get Composable Index Templates API
- Create or update composable index template API
- Delete Composable Index Template API
- Optional arguments
- Simulate Index Template API
- Cluster APIs
- Ingest APIs
- Snapshot APIs
- Tasks APIs
- Script APIs
- Licensing APIs
- Machine Learning APIs
- Close anomaly detection jobs API
- Delete anomaly detection jobs API
- Delete anomaly detection jobs from calendar API
- Delete calendar events API
- Delete calendars API
- Delete data frame analytics jobs API
- Delete datafeeds API
- Delete expired data API
- Delete filters API
- Delete forecasts API
- Delete model snapshots API
- Delete trained models API
- Estimate anomaly detection job model memory API
- Evaluate data frame analytics API
- Explain data frame analytics API
- Flush jobs API
- Forecast jobs API
- Get anomaly detection jobs API
- Get anomaly detection job stats API
- Get buckets API
- Get calendar events API
- Get calendars API
- Get categories API
- Get data frame analytics jobs API
- Get data frame analytics jobs stats API
- Get datafeeds API
- Get datafeed stats API
- Get filters API
- Get influencers API
- Get machine learning info API
- Get model snapshots API
- Get overall buckets API
- Get records API
- Get trained models API
- Get trained models stats API
- Open anomaly detection jobs API
- Post calendar events API
- Post data API
- Preview datafeeds API
- Create anomaly detection jobs API
- Add anomaly detection jobs to calendar API
- Create calendars API
- Create data frame analytics jobs API
- Create datafeeds API
- Create filters API
- Create trained models API
- Revert model snapshots API
- Set upgrade mode API
- Start data frame analytics jobs API
- Start datafeeds API
- Stop data frame analytics jobs API
- Stop datafeeds API
- Update anomaly detection jobs API
- Update data frame analytics jobs API
- Update datafeeds API
- Update filters API
- Update model snapshots API
- Upgrade job snapshot API
- Migration APIs
- Rollup APIs
- Security APIs
- Create or update user API
- Get Users API
- Delete User API
- Enable User API
- Disable User API
- Change Password API
- Create or update role API
- Get Roles API
- Delete Role API
- Delete Privileges API
- Get Builtin Privileges API
- Get Privileges API
- Clear Roles Cache API
- Clear Privileges Cache API
- Clear Realm Cache API
- Clear API Key Cache API
- Authenticate API
- Has Privileges API
- Get User Privileges API
- SSL Certificate API
- Create or update role mapping API
- Get Role Mappings API
- Delete Role Mapping API
- Create Token API
- Invalidate Token API
- Create or update privileges API
- Create API Key API
- Grant API key API
- Get API Key information API
- Invalidate API Key API
- Text Structure APIs
- Watcher APIs
- Graph APIs
- CCR APIs
- Index Lifecycle Management APIs
- Snapshot Lifecycle Management APIs
- Create or update snapshot lifecycle policy API
- Delete Snapshot Lifecycle Policy API
- Get Snapshot Lifecycle Policy API
- Start Snapshot Lifecycle Management API
- Stop Snapshot Lifecycle Management API
- Snapshot Lifecycle Management Status API
- Execute Snapshot Lifecycle Policy API
- Execute Snapshot Lifecycle Retention API
- Transform APIs
- Enrich APIs
- Using Java Builders
- Migration Guide
- License
Create transform API
editCreate transform API
editCreates a new transform.
The API accepts a PutTransformRequest
object as a request and returns a AcknowledgedResponse
.
Create transform request
editA PutTransformRequest
requires the following argument:
PutTransformRequest request = new PutTransformRequest(transformConfig); request.setDeferValidation(false);
The configuration of the transform to create |
|
Whether or not to wait to run deferrable validations until |
Transform configuration
editThe 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 |
|
The PivotConfig |
|
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 |
SourceConfig
editThe 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();
DestConfig
editThe 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();
QueryConfig
editThe query with which to select data from the source.
QueryConfig queryConfig = new QueryConfig(new MatchAllQueryBuilder());
PivotConfig
editDefines the pivot function group by
fields and the aggregation to reduce the data.
PivotConfig pivotConfig = PivotConfig.builder() .setGroups(groupConfig) .setAggregationConfig(aggConfig) .build();
GroupConfig
editThe grouping terms. Defines the group by and destination fields which are produced by the pivot function. There are 3 types of groups
- Terms
- Histogram
- Date Histogram
AggregationConfig
editDefines the aggregations for the group fields.
RetentionPolicyConfig
editDefines a retention policy for the transform. Data that meets the defined criteria is deleted from the destination index.
SettingsConfig
editDefines settings.
SyncConfig
editDefines the properties transforms require to run continuously.
Synchronous execution
editWhen executing a PutTransformRequest
in the following manner, the client waits
for the 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 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
editExecuting a 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
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 put-transform
looks like:
Response
editThe returned AcknowledgedResponse
acknowledges the successful creation of
the new transform or an error if the configuration is invalid.
On this page