Get Follow Info APIedit


The Get Follow Info API allows you to get follow information (parameters and status) for specific follower indices.

FollowInfoRequest request =
    new FollowInfoRequest("follower"); 

The follower index to get follow information for.


The returned FollowInfoResponse includes follow information for the specified follower indices

List<FollowInfoResponse.FollowerInfo> infos =

The follow information for specified follower indices.

Synchronous executionedit

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

FollowInfoResponse response = client.ccr()
    .getFollowInfo(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 executionedit

Executing a FollowInfoRequest 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 ccr-get-follow-info method:

    RequestOptions.DEFAULT, listener); 

The FollowInfoRequest 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 ccr-get-follow-info looks like:

ActionListener<FollowInfoResponse> listener =
    new ActionListener<FollowInfoResponse>() {
        public void onResponse(FollowInfoResponse response) { 
            List<FollowInfoResponse.FollowerInfo> infos =

        public void onFailure(Exception e) {

Called when the execution is successfully completed.

Called when the whole FollowInfoRequest fails.