Get datafeeds API

Retrieves configuration information about machine learning datafeeds in the cluster. It accepts a GetDatafeedRequest object and responds with a GetDatafeedResponse object.

Get datafeeds request

edit

A GetDatafeedRequest object gets can have any number of datafeedId entries. However, they all must be non-null. An empty list is the same as requesting for all datafeeds.

GetDatafeedRequest request = new GetDatafeedRequest(datafeedId); 
request.setAllowNoMatch(true); 
request.setExcludeGenerated(false);

	Constructing a new request referencing existing `datafeedIds`. It can contain wildcards.
	Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified).
	Optional boolean value for requesting the datafeed in a format that can then be put into another cluster. Certain fields that can only be set when the datafeed is created are removed.

Get datafeeds response

edit

long numberOfDatafeeds = response.count(); 
List<DatafeedConfig> datafeeds = response.datafeeds();

	The count of retrieved datafeeds.
	The retrieved datafeeds.

Synchronous execution

edit

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

GetDatafeedResponse response = client.machineLearning().getDatafeed(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

edit

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

client.machineLearning().getDatafeedAsync(request, RequestOptions.DEFAULT, listener);

The GetDatafeedRequest to execute and the ActionListener to use when the execution completes

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 get-datafeed looks like:

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

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

	Called when the execution is successfully completed.
	Called when the whole `GetDatafeedRequest` fails.

« Get data frame analytics jobs stats API Get datafeed stats API »