Put Rollup Job API

A PutRollupJobRequest requires the following argument:

PutRollupJobRequest request = new PutRollupJobRequest(config); 

The RollupJobConfig object contains all the details about the rollup job configuration. See Rollup configuration to learn more about the various configuration settings.

A RollupJobConfig requires the following arguments:

RollupJobConfig config = new RollupJobConfig(id, 
    indexPattern,  
    rollupIndex,  
    cron,  
    pageSize,  
    groups,  
    metrics,  
    timeout);  

The grouping configuration of the Rollup job is defined in the RollupJobConfig using a GroupConfig instance. GroupConfig reflects all the configuration settings that can be defined using the REST API. See Grouping Config to learn more about these settings.

Using the REST API, we could define this grouping configuration:

"groups" : {
  "date_histogram": {
    "field": "timestamp",
    "calendar_interval": "1h",
    "delay": "7d",
    "time_zone": "UTC"
  },
  "terms": {
    "fields": ["hostname", "datacenter"]
  },
  "histogram": {
    "fields": ["load", "net_in", "net_out"],
    "interval": 5
  }
}

Using the GroupConfig object and the high level REST client, the same configuration would be:

DateHistogramGroupConfig dateHistogram =
    new DateHistogramGroupConfig("timestamp", DateHistogramInterval.HOUR, new DateHistogramInterval("7d"), "UTC"); 
TermsGroupConfig terms = new TermsGroupConfig("hostname", "datacenter"); 
HistogramGroupConfig histogram = new HistogramGroupConfig(5L, "load", "net_in", "net_out"); 

GroupConfig groups = new GroupConfig(dateHistogram, histogram, terms); 

After defining which groups should be generated for the data, you next configure which metrics should be collected. The list of metrics is defined in the RollupJobConfig using a List<MetricConfig> instance. MetricConfig reflects all the configuration settings that can be defined using the REST API. See Metrics Config to learn more about these settings.

Using the REST API, we could define this metrics configuration:

"metrics": [
    {
        "field": "temperature",
        "metrics": ["min", "max", "sum"]
    },
    {
        "field": "voltage",
        "metrics": ["avg", "value_count"]
    }
]

Using the MetricConfig object and the high level REST client, the same configuration would be:

List<MetricConfig> metrics = new ArrayList<>(); 
metrics.add(new MetricConfig("temperature", Arrays.asList("min", "max", "sum"))); 
metrics.add(new MetricConfig("voltage", Arrays.asList("avg", "value_count"))); 

The Put Rollup Job API can be executed through a RollupClient instance. Such instance can be retrieved from a RestHighLevelClient using the rollup() method:

AcknowledgedResponse response = client.rollup().putRollupJob(request, RequestOptions.DEFAULT);

The returned PutRollupJobResponse indicates if the new Rollup job has been successfully created:

boolean acknowledged = response.isAcknowledged(); 

This request can be executed asynchronously:

client.rollup().putRollupJobAsync(request, RequestOptions.DEFAULT, listener); 

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.

A typical listener for PutRollupJobResponse looks like:

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

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