Get Overall Buckets API
edit The Get Overall Buckets API retrieves overall bucket results that
summarize the bucket results of multiple jobs.
It accepts a GetOverallBucketsRequest object and responds
with a GetOverallBucketsResponse object.
Get Overall Buckets Request
edit A GetOverallBucketsRequest object gets created with one or more jobId.
GetOverallBucketsRequest request = new GetOverallBucketsRequest(jobId1, jobId2);
|
|
Constructing a new request referencing job IDs jobId1 and jobId2.
|
The following arguments are optional:
request.setBucketSpan(TimeValue.timeValueHours(24));
|
|
The span of the overall buckets. Must be greater or equal to the jobs' largest bucket_span.
|
request.setEnd("2018-08-21T00:00:00Z");
|
|
Overall buckets with timestamps earlier than this time will be returned.
|
request.setExcludeInterim(true);
|
|
If true, interim results will be excluded. Overall buckets are interim if any of the job buckets
within the overall bucket interval are interim. Defaults to false.
|
request.setOverallScore(75.0);
|
|
Overall buckets with overall scores greater or equal than this value will be returned.
|
request.setStart("2018-08-01T00:00:00Z");
|
|
Overall buckets with timestamps on or after this time will be returned.
|
|
|
The number of top job bucket scores to be used in the overall_score calculation. Defaults to 1.
|
Synchronous Execution
edit When executing a GetOverallBucketsRequest in the following manner, the client waits
for the GetOverallBucketsResponse to be returned before continuing with code execution:
GetOverallBucketsResponse response = client.machineLearning().getOverallBuckets(request, RequestOptions.DEFAULT);
Asynchronous Execution
edit Executing a GetOverallBucketsRequest 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-overall-buckets method:
client.machineLearning().getOverallBucketsAsync(request, RequestOptions.DEFAULT, listener);
|
|
The GetOverallBucketsRequest 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.
A typical listener for get-overall-buckets looks like:
ActionListener<GetOverallBucketsResponse> listener =
new ActionListener<GetOverallBucketsResponse>() {
@Override
public void onResponse(GetOverallBucketsResponse getOverallBucketsResponse) {
}
@Override
public void onFailure(Exception e) {
}
};
|
|
Called when the execution is successfully completed.
|
|
|
Called when the whole GetOverallBucketsRequest fails.
|
Get Overall Buckets Response
edit The returned GetOverallBucketsResponse contains the requested buckets:
long count = response.count();
List<OverallBucket> overallBuckets = response.overallBuckets();
|
|
The count of overall buckets that were matched
|
|
|
The overall buckets retrieved
|