Get Rollup Job API
editGet Rollup Job API
editThis functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
The Get Rollup Job API can be used to get one or all rollup jobs from the
cluster. It accepts a GetRollupJobRequest
object as a request and returns
a GetRollupJobResponse
.
Get Rollup Job Request
editA GetRollupJobRequest
can be built without any parameters to get all of the
rollup jobs or with a job name to get a single job:
Execution
editThe Get Rollup Job API can be executed through a RollupClient
instance. Such instance can be retrieved from a RestHighLevelClient
using the rollup()
method:
GetRollupJobResponse response = client.rollup().getRollupJob(getJob, RequestOptions.DEFAULT);
Response
editThe returned GetRollupJobResponse
includes a JobWrapper
per returned job
which contains the configuration of the job, the job’s current status, and
statistics about the job’s past execution.
Asynchronous Execution
editThis request can be executed asynchronously:
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 GetRollupJobResponse
looks like: