Get Records API

The Get Records API retrieves one or more record results. It accepts a GetRecordsRequest object and responds with a GetRecordsResponse object.

Get Records Request

A GetRecordsRequest object gets created with an existing non-null jobId.

GetRecordsRequest request = new GetRecordsRequest(jobId); 

Constructing a new request referencing an existing jobId

Optional Arguments

The following arguments are optional:

request.setDescending(true); 

If true, the records are sorted in descending order. Defaults to false.

request.setEnd("2018-08-21T00:00:00Z"); 

Records with timestamps earlier than this time will be returned.

request.setExcludeInterim(true); 

If true, interim results will be excluded. Defaults to false.

request.setPageParams(new PageParams(100, 200)); 

The page parameters from and size. from specifies the number of records to skip. size specifies the maximum number of records to get. Defaults to 0 and 100 respectively.

request.setRecordScore(75.0); 

Records with record_score greater or equal than this value will be returned.

request.setSort("probability"); 

The field to sort records on. Defaults to record_score.

request.setStart("2018-08-01T00:00:00Z"); 

Records with timestamps on or after this time will be returned.

Synchronous Execution

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

GetRecordsResponse response = client.machineLearning().getRecords(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

Executing a GetRecordsRequest 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-records method:

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

The GetRecordsRequest 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-records looks like:

ActionListener<GetRecordsResponse> listener =
        new ActionListener<GetRecordsResponse>() {
            @Override
            public void onResponse(GetRecordsResponse getRecordsResponse) {
                
            }

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

Called when the execution is successfully completed.

Called when the whole GetRecordsRequest fails.

Get Records Response

The returned GetRecordsResponse contains the requested records:

long count = response.count(); 
List<AnomalyRecord> records = response.records(); 

The count of records that were matched

The records retrieved