Retrieves the operational statistics of one or more transforms.
The API accepts a
GetTransformStatsRequest object and returns a
GetTransformStatsRequest requires a transform id or the special wildcard
to get the statistics for all transforms.
The following arguments are optional.
When executing a
GetTransformStatsRequest in the following manner, the client waits
GetTransformStatsResponse to be returned before continuing with code execution:
GetTransformStatsResponse response = client.transform() .getTransformStats(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
5xx error code, the high-level
client tries to parse the response body error details instead and then throws
ElasticsearchException and adds the original
ResponseException as a
suppressed exception to it.
GetTransformStatsRequest 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-transform-stats method:
The asynchronous method does not block and returns immediately. Once it is
ActionListener is called back using the
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-transform-stats looks like:
GetTransformStatsResponse contains the requested transform statistics.
TransformStats stats = response.getTransformsStats().get(0); TransformStats.State state = stats.getState(); TransformIndexerStats indexerStats = stats.getIndexerStats(); TransformProgress progress = stats.getCheckpointingInfo() .getNext().getCheckpointProgress(); NodeAttributes node = stats.getNode();
The response contains a list of
The running state of the transform, for example
The overall transform statistics recording the number of documents indexed etc.
The progress of the current run in the transform. Supplies the number of docs left until the next checkpoint and the total number of docs expected.
The assigned node information if the task is currently assigned to a node and running.