org.elasticsearch.client
Interface ClusterAdminClient

All Known Subinterfaces:
InternalClusterAdminClient
All Known Implementing Classes:
AbstractClusterAdminClient, InternalTransportClusterAdminClient, NodeClusterAdminClient

public interface ClusterAdminClient

Administrative actions/operations against indices.

See Also:
AdminClient.cluster()

Method Summary
 ActionFuture<ClusterHealthResponse> health(ClusterHealthRequest request)
          The health of the cluster.
 void health(ClusterHealthRequest request, ActionListener<ClusterHealthResponse> listener)
          The health of the cluster.
 ActionFuture<NodesInfoResponse> nodesInfo(NodesInfoRequest request)
          Nodes info of the cluster.
 void nodesInfo(NodesInfoRequest request, ActionListener<NodesInfoResponse> listener)
          Nodes info of the cluster.
 ActionFuture<NodesRestartResponse> nodesRestart(NodesRestartRequest request)
          Restarts nodes in the cluster.
 void nodesRestart(NodesRestartRequest request, ActionListener<NodesRestartResponse> listener)
          Restarts nodes in the cluster.
 ActionFuture<NodesShutdownResponse> nodesShutdown(NodesShutdownRequest request)
          Shutdown nodes in the cluster.
 void nodesShutdown(NodesShutdownRequest request, ActionListener<NodesShutdownResponse> listener)
          Shutdown nodes in the cluster.
 ActionFuture<NodesStatsResponse> nodesStats(NodesStatsRequest request)
          Nodes stats of the cluster.
 void nodesStats(NodesStatsRequest request, ActionListener<NodesStatsResponse> listener)
          Nodes stats of the cluster.
 ActionFuture<BroadcastPingResponse> ping(BroadcastPingRequest request)
           
 void ping(BroadcastPingRequest request, ActionListener<BroadcastPingResponse> listener)
           
 ActionFuture<ReplicationPingResponse> ping(ReplicationPingRequest request)
           
 void ping(ReplicationPingRequest request, ActionListener<ReplicationPingResponse> listener)
           
 ActionFuture<SinglePingResponse> ping(SinglePingRequest request)
           
 void ping(SinglePingRequest request, ActionListener<SinglePingResponse> listener)
           
 ClusterHealthRequestBuilder prepareHealth(java.lang.String... indices)
          The health of the cluster.
 NodesInfoRequestBuilder prepareNodesInfo(java.lang.String... nodesIds)
          Nodes info of the cluster.
 NodesRestartRequestBuilder prepareNodesRestart(java.lang.String... nodesIds)
          Restarts nodes in the cluster.
 NodesShutdownRequestBuilder prepareNodesShutdown(java.lang.String... nodesIds)
          Shutdown nodes in the cluster.
 NodesStatsRequestBuilder prepareNodesStats(java.lang.String... nodesIds)
          Nodes stats of the cluster.
 BroadcastPingRequestBuilder preparePingBroadcast(java.lang.String... indices)
           
 ReplicationPingRequestBuilder preparePingReplication(java.lang.String... indices)
           
 SinglePingRequestBuilder preparePingSingle()
           
 SinglePingRequestBuilder preparePingSingle(java.lang.String index, java.lang.String type, java.lang.String id)
           
 ClusterStateRequestBuilder prepareState()
          The state of the cluster.
 ActionFuture<ClusterStateResponse> state(ClusterStateRequest request)
          The state of the cluster.
 void state(ClusterStateRequest request, ActionListener<ClusterStateResponse> listener)
          The state of the cluster.
 

Method Detail

health

ActionFuture<ClusterHealthResponse> health(ClusterHealthRequest request)
The health of the cluster.

Parameters:
request - The cluster state request
Returns:
The result future
See Also:
Requests.clusterHealthRequest(String...)

health

void health(ClusterHealthRequest request,
            ActionListener<ClusterHealthResponse> listener)
The health of the cluster.

Parameters:
request - The cluster state request
listener - A listener to be notified with a result
See Also:
Requests.clusterHealthRequest(String...)

prepareHealth

ClusterHealthRequestBuilder prepareHealth(java.lang.String... indices)
The health of the cluster.


state

ActionFuture<ClusterStateResponse> state(ClusterStateRequest request)
The state of the cluster.

Parameters:
request - The cluster state request.
Returns:
The result future
See Also:
Requests.clusterStateRequest()

state

void state(ClusterStateRequest request,
           ActionListener<ClusterStateResponse> listener)
The state of the cluster.

Parameters:
request - The cluster state request.
listener - A listener to be notified with a result
See Also:
Requests.clusterStateRequest()

prepareState

ClusterStateRequestBuilder prepareState()
The state of the cluster.


nodesInfo

ActionFuture<NodesInfoResponse> nodesInfo(NodesInfoRequest request)
Nodes info of the cluster.

Parameters:
request - The nodes info request
Returns:
The result future
See Also:
Requests.nodesInfoRequest(String...)

nodesInfo

void nodesInfo(NodesInfoRequest request,
               ActionListener<NodesInfoResponse> listener)
Nodes info of the cluster.

Parameters:
request - The nodes info request
listener - A listener to be notified with a result
See Also:
Requests.nodesInfoRequest(String...)

prepareNodesInfo

NodesInfoRequestBuilder prepareNodesInfo(java.lang.String... nodesIds)
Nodes info of the cluster.


nodesStats

ActionFuture<NodesStatsResponse> nodesStats(NodesStatsRequest request)
Nodes stats of the cluster.

Parameters:
request - The nodes info request
Returns:
The result future
See Also:
Requests.nodesStatsRequest(String...)

nodesStats

void nodesStats(NodesStatsRequest request,
                ActionListener<NodesStatsResponse> listener)
Nodes stats of the cluster.

Parameters:
request - The nodes info request
listener - A listener to be notified with a result
See Also:
Requests.nodesStatsRequest(String...)

prepareNodesStats

NodesStatsRequestBuilder prepareNodesStats(java.lang.String... nodesIds)
Nodes stats of the cluster.


nodesShutdown

ActionFuture<NodesShutdownResponse> nodesShutdown(NodesShutdownRequest request)
Shutdown nodes in the cluster.

Parameters:
request - The nodes shutdown request
Returns:
The result future
See Also:
Requests.nodesShutdownRequest(String...)

nodesShutdown

void nodesShutdown(NodesShutdownRequest request,
                   ActionListener<NodesShutdownResponse> listener)
Shutdown nodes in the cluster.

Parameters:
request - The nodes shutdown request
listener - A listener to be notified with a result
See Also:
Requests.nodesShutdownRequest(String...)

prepareNodesShutdown

NodesShutdownRequestBuilder prepareNodesShutdown(java.lang.String... nodesIds)
Shutdown nodes in the cluster.


nodesRestart

ActionFuture<NodesRestartResponse> nodesRestart(NodesRestartRequest request)
Restarts nodes in the cluster.

Parameters:
request - The nodes restart request
Returns:
The result future
See Also:
Requests.nodesRestartRequest(String...)

nodesRestart

void nodesRestart(NodesRestartRequest request,
                  ActionListener<NodesRestartResponse> listener)
Restarts nodes in the cluster.

Parameters:
request - The nodes restart request
listener - A listener to be notified with a result
See Also:
Requests.nodesRestartRequest(String...)

prepareNodesRestart

NodesRestartRequestBuilder prepareNodesRestart(java.lang.String... nodesIds)
Restarts nodes in the cluster.


ping

ActionFuture<SinglePingResponse> ping(SinglePingRequest request)

ping

void ping(SinglePingRequest request,
          ActionListener<SinglePingResponse> listener)

preparePingSingle

SinglePingRequestBuilder preparePingSingle()

preparePingSingle

SinglePingRequestBuilder preparePingSingle(java.lang.String index,
                                           java.lang.String type,
                                           java.lang.String id)

ping

ActionFuture<BroadcastPingResponse> ping(BroadcastPingRequest request)

ping

void ping(BroadcastPingRequest request,
          ActionListener<BroadcastPingResponse> listener)

preparePingBroadcast

BroadcastPingRequestBuilder preparePingBroadcast(java.lang.String... indices)

ping

ActionFuture<ReplicationPingResponse> ping(ReplicationPingRequest request)

ping

void ping(ReplicationPingRequest request,
          ActionListener<ReplicationPingResponse> listener)

preparePingReplication

ReplicationPingRequestBuilder preparePingReplication(java.lang.String... indices)