Create datafeeds API

A PutDatafeedRequest requires the following argument:

PutDatafeedRequest request = new PutDatafeedRequest(datafeedBuilder.build()); 

The DatafeedConfig object contains all the details about the machine learning datafeed configuration.

A DatafeedConfig requires the following arguments:

DatafeedConfig.Builder datafeedBuilder = new DatafeedConfig.Builder(id, jobId) 
        .setIndices("index_1", "index_2");  

The following arguments are optional:

datafeedBuilder.setChunkingConfig(ChunkingConfig.newAuto()); 

datafeedBuilder.setFrequency(TimeValue.timeValueSeconds(30)); 

datafeedBuilder.setQuery(QueryBuilders.matchAllQuery()); 

datafeedBuilder.setQueryDelay(TimeValue.timeValueMinutes(1)); 

datafeedBuilder.setDelayedDataCheckConfig(DelayedDataCheckConfig
    .enabledDelayedDataCheckConfig(TimeValue.timeValueHours(1))); 

datafeedBuilder.setScriptFields(scriptFields); 

datafeedBuilder.setScrollSize(1000); 

Map<String, Object> fieldProperties = new HashMap<>();
fieldProperties.put("type", "keyword");
fieldProperties.put("script", "emit(params._source.agent.toLowerCase())");
Map<String, Object> runtimeMappings = new HashMap<>();
runtimeMappings.put("agent_lowercase", fieldProperties);

datafeedBuilder.setRuntimeMappings(runtimeMappings); 

When executing a PutDatafeedRequest in the following manner, the client waits for the PutDatafeedResponse to be returned before continuing with code execution:

PutDatafeedResponse response = client.machineLearning().putDatafeed(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.

Executing a PutDatafeedRequest 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-datafeed method:

client.machineLearning().putDatafeedAsync(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. Failure scenarios and expected exceptions are the same as in the synchronous execution case.

A typical listener for put-datafeed looks like:

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

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

The returned PutDatafeedResponse returns the full representation of the new machine learning datafeed if it has been successfully created. This will contain the creation time and other fields initialized using default values:

DatafeedConfig datafeed = response.getResponse();