The Get Buckets API retrieves one or more bucket results.
It accepts a GetBucketsRequest object and responds
with a GetBucketsResponse object.
A GetBucketsRequest object gets created with an existing non-null jobId.
GetBucketsRequest request = new GetBucketsRequest(jobId);
|
|
Constructing a new request referencing an existing jobId
|
The following arguments are optional:
request.setTimestamp("2018-08-17T00:00:00Z");
|
|
The timestamp of the bucket to get. Otherwise it will return all buckets.
|
request.setAnomalyScore(75.0);
|
|
Buckets with anomaly scores greater or equal than this value will be returned.
|
request.setDescending(true);
|
|
If true, the buckets are sorted in descending order. Defaults to false.
|
request.setEnd("2018-08-21T00:00:00Z");
|
|
Buckets with timestamps earlier than this time will be returned.
|
request.setExcludeInterim(true);
|
|
If true, interim results will be excluded. Defaults to false.
|
|
|
If true, buckets will include their anomaly records. Defaults to false.
|
request.setPageParams(new PageParams(100, 200));
|
|
The page parameters from and size. from specifies the number of buckets to skip.
size specifies the maximum number of buckets to get. Defaults to 0 and 100 respectively.
|
request.setSort("anomaly_score");
|
|
The field to sort buckets on. Defaults to timestamp.
|
request.setStart("2018-08-01T00:00:00Z");
|
|
Buckets with timestamps on or after this time will be returned.
|
Synchronous Execution
edit When executing a GetBucketsRequest in the following manner, the client waits
for the GetBucketsResponse to be returned before continuing with code execution:
GetBucketsResponse response = client.machineLearning().getBuckets(request, RequestOptions.DEFAULT);
Asynchronous Execution
edit Executing a GetBucketsRequest 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-buckets method:
client.machineLearning().getBucketsAsync(request, RequestOptions.DEFAULT, listener);
|
|
The GetBucketsRequest 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-buckets looks like:
ActionListener<GetBucketsResponse> listener =
new ActionListener<GetBucketsResponse>() {
@Override
public void onResponse(GetBucketsResponse getBucketsResponse) {
}
@Override
public void onFailure(Exception e) {
}
};
|
|
Called when the execution is successfully completed.
|
|
|
Called when the whole GetBucketsRequest fails.
|
The returned GetBucketsResponse contains the requested buckets:
long count = response.count();
List<Bucket> buckets = response.buckets();
|
|
The count of buckets that were matched
|
|
|
The buckets retrieved
|