org.elasticsearch.client

Interface ClusterAdminClient

All Superinterfaces:

ElasticsearchClient

public interface ClusterAdminClient
extends ElasticsearchClient

Administrative actions/operations against indices.

See Also:

AdminClient.cluster()

Method Summary

Methods

Modifier and Type	Method and Description
ActionFuture<CancelTasksResponse>	cancelTasks(CancelTasksRequest request) Cancel tasks
void	cancelTasks(CancelTasksRequest request, ActionListener<CancelTasksResponse> listener) Cancel active tasks
ActionFuture<ClusterStatsResponse>	clusterStats(ClusterStatsRequest request) Cluster wide aggregated stats.
void	clusterStats(ClusterStatsRequest request, ActionListener<ClusterStatsResponse> listener) Cluster wide aggregated stats
ActionFuture<CreateSnapshotResponse>	createSnapshot(CreateSnapshotRequest request) Creates a new snapshot.
void	createSnapshot(CreateSnapshotRequest request, ActionListener<CreateSnapshotResponse> listener) Creates a new snapshot.
ActionFuture<DeleteRepositoryResponse>	deleteRepository(DeleteRepositoryRequest request) Unregisters a repository.
void	deleteRepository(DeleteRepositoryRequest request, ActionListener<DeleteRepositoryResponse> listener) Unregisters a repository.
ActionFuture<DeleteSnapshotResponse>	deleteSnapshot(DeleteSnapshotRequest request) Delete snapshot.
void	deleteSnapshot(DeleteSnapshotRequest request, ActionListener<DeleteSnapshotResponse> listener) Delete snapshot.
ActionFuture<GetRepositoriesResponse>	getRepositories(GetRepositoriesRequest request) Gets repositories.
void	getRepositories(GetRepositoriesRequest request, ActionListener<GetRepositoriesResponse> listener) Gets repositories.
ActionFuture<GetSnapshotsResponse>	getSnapshots(GetSnapshotsRequest request) Get snapshot.
void	getSnapshots(GetSnapshotsRequest request, ActionListener<GetSnapshotsResponse> listener) Get snapshot.
ActionFuture<ClusterHealthResponse>	health(ClusterHealthRequest request) The health of the cluster.
void	health(ClusterHealthRequest request, ActionListener<ClusterHealthResponse> listener) The health of the cluster.
ActionFuture<ListTasksResponse>	listTasks(ListTasksRequest request) List tasks
void	listTasks(ListTasksRequest request, ActionListener<ListTasksResponse> listener) List active tasks
ActionFuture<NodesHotThreadsResponse>	nodesHotThreads(NodesHotThreadsRequest request) Returns top N hot-threads samples per node.
void	nodesHotThreads(NodesHotThreadsRequest request, ActionListener<NodesHotThreadsResponse> listener) Returns top N hot-threads samples per node.
ActionFuture<NodesInfoResponse>	nodesInfo(NodesInfoRequest request) Nodes info of the cluster.
void	nodesInfo(NodesInfoRequest request, ActionListener<NodesInfoResponse> listener) Nodes info of 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<PendingClusterTasksResponse>	pendingClusterTasks(PendingClusterTasksRequest request) Returns a list of the pending cluster tasks, that are scheduled to be executed.
void	pendingClusterTasks(PendingClusterTasksRequest request, ActionListener<PendingClusterTasksResponse> listener) Returns a list of the pending cluster tasks, that are scheduled to be executed.
CancelTasksRequestBuilder	prepareCancelTasks(String... nodesIds) Cancel active tasks
ClusterStatsRequestBuilder	prepareClusterStats()
CreateSnapshotRequestBuilder	prepareCreateSnapshot(String repository, String name) Creates a new snapshot.
DeleteRepositoryRequestBuilder	prepareDeleteRepository(String name) Unregisters a repository.
DeleteSnapshotRequestBuilder	prepareDeleteSnapshot(String repository, String snapshot) Delete snapshot.
GetRepositoriesRequestBuilder	prepareGetRepositories(String... name) Gets repositories.
GetSnapshotsRequestBuilder	prepareGetSnapshots(String repository) Get snapshot.
ClusterHealthRequestBuilder	prepareHealth(String... indices) The health of the cluster.
ListTasksRequestBuilder	prepareListTasks(String... nodesIds) List active tasks
NodesHotThreadsRequestBuilder	prepareNodesHotThreads(String... nodesIds) Returns a request builder to fetch top N hot-threads samples per node.
NodesInfoRequestBuilder	prepareNodesInfo(String... nodesIds) Nodes info of the cluster.
NodesStatsRequestBuilder	prepareNodesStats(String... nodesIds) Nodes stats of the cluster.
PendingClusterTasksRequestBuilder	preparePendingClusterTasks() Returns a list of the pending cluster tasks, that are scheduled to be executed.
PutRepositoryRequestBuilder	preparePutRepository(String name) Registers a snapshot repository.
RenderSearchTemplateRequestBuilder	prepareRenderSearchTemplate() Return the rendered search request for a given search template.
ClusterRerouteRequestBuilder	prepareReroute() Update settings in the cluster.
RestoreSnapshotRequestBuilder	prepareRestoreSnapshot(String repository, String snapshot) Restores a snapshot.
ClusterSearchShardsRequestBuilder	prepareSearchShards() Returns list of shards the given search would be executed on.
ClusterSearchShardsRequestBuilder	prepareSearchShards(String... indices) Returns list of shards the given search would be executed on.
SnapshotsStatusRequestBuilder	prepareSnapshotStatus() Get snapshot status.
SnapshotsStatusRequestBuilder	prepareSnapshotStatus(String repository) Get snapshot status.
ClusterStateRequestBuilder	prepareState() The state of the cluster.
ClusterUpdateSettingsRequestBuilder	prepareUpdateSettings() Update settings in the cluster.
VerifyRepositoryRequestBuilder	prepareVerifyRepository(String name) Verifies a repository.
ActionFuture<PutRepositoryResponse>	putRepository(PutRepositoryRequest request) Registers a snapshot repository.
void	putRepository(PutRepositoryRequest request, ActionListener<PutRepositoryResponse> listener) Registers a snapshot repository.
ActionFuture<RenderSearchTemplateResponse>	renderSearchTemplate(RenderSearchTemplateRequest request) Return the rendered search request for a given search template.
void	renderSearchTemplate(RenderSearchTemplateRequest request, ActionListener<RenderSearchTemplateResponse> listener) Return the rendered search request for a given search template.
ActionFuture<ClusterRerouteResponse>	reroute(ClusterRerouteRequest request) Reroutes allocation of shards.
void	reroute(ClusterRerouteRequest request, ActionListener<ClusterRerouteResponse> listener) Reroutes allocation of shards.
ActionFuture<RestoreSnapshotResponse>	restoreSnapshot(RestoreSnapshotRequest request) Restores a snapshot.
void	restoreSnapshot(RestoreSnapshotRequest request, ActionListener<RestoreSnapshotResponse> listener) Restores a snapshot.
ActionFuture<ClusterSearchShardsResponse>	searchShards(ClusterSearchShardsRequest request) Returns list of shards the given search would be executed on.
void	searchShards(ClusterSearchShardsRequest request, ActionListener<ClusterSearchShardsResponse> listener) Returns list of shards the given search would be executed on.
ActionFuture<SnapshotsStatusResponse>	snapshotsStatus(SnapshotsStatusRequest request) Get snapshot status.
void	snapshotsStatus(SnapshotsStatusRequest request, ActionListener<SnapshotsStatusResponse> listener) Get snapshot status.
ActionFuture<ClusterStateResponse>	state(ClusterStateRequest request) The state of the cluster.
void	state(ClusterStateRequest request, ActionListener<ClusterStateResponse> listener) The state of the cluster.
ActionFuture<ClusterUpdateSettingsResponse>	updateSettings(ClusterUpdateSettingsRequest request) Updates settings in the cluster.
void	updateSettings(ClusterUpdateSettingsRequest request, ActionListener<ClusterUpdateSettingsResponse> listener) Update settings in the cluster.
ActionFuture<VerifyRepositoryResponse>	verifyRepository(VerifyRepositoryRequest request) Verifies a repository.
void	verifyRepository(VerifyRepositoryRequest request, ActionListener<VerifyRepositoryResponse> listener) Verifies a repository.

Methods inherited from interface org.elasticsearch.client.ElasticsearchClient

execute, execute, prepareExecute, threadPool

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(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.

updateSettings

ActionFuture<ClusterUpdateSettingsResponse> updateSettings(ClusterUpdateSettingsRequest request)

Updates settings in the cluster.

updateSettings

void updateSettings(ClusterUpdateSettingsRequest request,
                  ActionListener<ClusterUpdateSettingsResponse> listener)

Update settings in the cluster.

prepareUpdateSettings

ClusterUpdateSettingsRequestBuilder prepareUpdateSettings()

Update settings in the cluster.

reroute

ActionFuture<ClusterRerouteResponse> reroute(ClusterRerouteRequest request)

Reroutes allocation of shards. Advance API.

reroute

void reroute(ClusterRerouteRequest request,
           ActionListener<ClusterRerouteResponse> listener)

Reroutes allocation of shards. Advance API.

prepareReroute

ClusterRerouteRequestBuilder prepareReroute()

Update settings in 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(String... nodesIds)

Nodes info of the cluster.

clusterStats

ActionFuture<ClusterStatsResponse> clusterStats(ClusterStatsRequest request)

Cluster wide aggregated stats.

Parameters:

request - The cluster stats request

Returns:

The result future

See Also:

Requests.clusterStatsRequest()

clusterStats

void clusterStats(ClusterStatsRequest request,
                ActionListener<ClusterStatsResponse> listener)

Cluster wide aggregated stats

Parameters:

request - The cluster stats request

listener - A listener to be notified with a result

See Also:

Requests.clusterStatsRequest()

prepareClusterStats

ClusterStatsRequestBuilder prepareClusterStats()

nodesStats

ActionFuture<NodesStatsResponse> nodesStats(NodesStatsRequest request)

Nodes stats of the cluster.

Parameters:

request - The nodes stats 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(String... nodesIds)

Nodes stats of the cluster.

nodesHotThreads

ActionFuture<NodesHotThreadsResponse> nodesHotThreads(NodesHotThreadsRequest request)

Returns top N hot-threads samples per node. The hot-threads are only sampled for the node ids specified in the request.

nodesHotThreads

void nodesHotThreads(NodesHotThreadsRequest request,
                   ActionListener<NodesHotThreadsResponse> listener)

Returns top N hot-threads samples per node. The hot-threads are only sampled for the node ids specified in the request.

prepareNodesHotThreads

NodesHotThreadsRequestBuilder prepareNodesHotThreads(String... nodesIds)

Returns a request builder to fetch top N hot-threads samples per node. The hot-threads are only sampled for the node ids provided. Note: Use * to fetch samples for all nodes

listTasks

ActionFuture<ListTasksResponse> listTasks(ListTasksRequest request)

List tasks

Parameters:

request - The nodes tasks request

Returns:

The result future

See Also:

Requests.listTasksRequest()

listTasks

void listTasks(ListTasksRequest request,
             ActionListener<ListTasksResponse> listener)

List active tasks

Parameters:

request - The nodes tasks request

listener - A listener to be notified with a result

See Also:

Requests.listTasksRequest()

prepareListTasks

ListTasksRequestBuilder prepareListTasks(String... nodesIds)

List active tasks

cancelTasks

ActionFuture<CancelTasksResponse> cancelTasks(CancelTasksRequest request)

Cancel tasks

Parameters:

request - The nodes tasks request

Returns:

The result future

See Also:

Requests.cancelTasksRequest()

cancelTasks

void cancelTasks(CancelTasksRequest request,
               ActionListener<CancelTasksResponse> listener)

Cancel active tasks

Parameters:

request - The nodes tasks request

listener - A cancelener to be notified with a result

See Also:

Requests.cancelTasksRequest()

prepareCancelTasks

CancelTasksRequestBuilder prepareCancelTasks(String... nodesIds)

Cancel active tasks

searchShards

ActionFuture<ClusterSearchShardsResponse> searchShards(ClusterSearchShardsRequest request)

Returns list of shards the given search would be executed on.

searchShards

void searchShards(ClusterSearchShardsRequest request,
                ActionListener<ClusterSearchShardsResponse> listener)

Returns list of shards the given search would be executed on.

prepareSearchShards

ClusterSearchShardsRequestBuilder prepareSearchShards()

Returns list of shards the given search would be executed on.

prepareSearchShards

ClusterSearchShardsRequestBuilder prepareSearchShards(String... indices)

Returns list of shards the given search would be executed on.

putRepository

ActionFuture<PutRepositoryResponse> putRepository(PutRepositoryRequest request)

Registers a snapshot repository.

putRepository

void putRepository(PutRepositoryRequest request,
                 ActionListener<PutRepositoryResponse> listener)

Registers a snapshot repository.

preparePutRepository

PutRepositoryRequestBuilder preparePutRepository(String name)

Registers a snapshot repository.

deleteRepository

ActionFuture<DeleteRepositoryResponse> deleteRepository(DeleteRepositoryRequest request)

Unregisters a repository.

deleteRepository

void deleteRepository(DeleteRepositoryRequest request,
                    ActionListener<DeleteRepositoryResponse> listener)

Unregisters a repository.

prepareDeleteRepository

DeleteRepositoryRequestBuilder prepareDeleteRepository(String name)

Unregisters a repository.

getRepositories

ActionFuture<GetRepositoriesResponse> getRepositories(GetRepositoriesRequest request)

Gets repositories.

getRepositories

void getRepositories(GetRepositoriesRequest request,
                   ActionListener<GetRepositoriesResponse> listener)

Gets repositories.

prepareGetRepositories

GetRepositoriesRequestBuilder prepareGetRepositories(String... name)

Gets repositories.

verifyRepository

ActionFuture<VerifyRepositoryResponse> verifyRepository(VerifyRepositoryRequest request)

Verifies a repository.

verifyRepository

void verifyRepository(VerifyRepositoryRequest request,
                    ActionListener<VerifyRepositoryResponse> listener)

Verifies a repository.

prepareVerifyRepository

VerifyRepositoryRequestBuilder prepareVerifyRepository(String name)

Verifies a repository.

createSnapshot

ActionFuture<CreateSnapshotResponse> createSnapshot(CreateSnapshotRequest request)

Creates a new snapshot.

createSnapshot

void createSnapshot(CreateSnapshotRequest request,
                  ActionListener<CreateSnapshotResponse> listener)

Creates a new snapshot.

prepareCreateSnapshot

CreateSnapshotRequestBuilder prepareCreateSnapshot(String repository,
                                                 String name)

Creates a new snapshot.

getSnapshots

ActionFuture<GetSnapshotsResponse> getSnapshots(GetSnapshotsRequest request)

Get snapshot.

getSnapshots

void getSnapshots(GetSnapshotsRequest request,
                ActionListener<GetSnapshotsResponse> listener)

Get snapshot.

prepareGetSnapshots

GetSnapshotsRequestBuilder prepareGetSnapshots(String repository)

Get snapshot.

deleteSnapshot

ActionFuture<DeleteSnapshotResponse> deleteSnapshot(DeleteSnapshotRequest request)

Delete snapshot.

deleteSnapshot

void deleteSnapshot(DeleteSnapshotRequest request,
                  ActionListener<DeleteSnapshotResponse> listener)

Delete snapshot.

prepareDeleteSnapshot

DeleteSnapshotRequestBuilder prepareDeleteSnapshot(String repository,
                                                 String snapshot)

Delete snapshot.

restoreSnapshot

ActionFuture<RestoreSnapshotResponse> restoreSnapshot(RestoreSnapshotRequest request)

Restores a snapshot.

restoreSnapshot

void restoreSnapshot(RestoreSnapshotRequest request,
                   ActionListener<RestoreSnapshotResponse> listener)

Restores a snapshot.

prepareRestoreSnapshot

RestoreSnapshotRequestBuilder prepareRestoreSnapshot(String repository,
                                                   String snapshot)

Restores a snapshot.

pendingClusterTasks

void pendingClusterTasks(PendingClusterTasksRequest request,
                       ActionListener<PendingClusterTasksResponse> listener)

Returns a list of the pending cluster tasks, that are scheduled to be executed. This includes operations that update the cluster state (for example, a create index operation)

pendingClusterTasks

ActionFuture<PendingClusterTasksResponse> pendingClusterTasks(PendingClusterTasksRequest request)

Returns a list of the pending cluster tasks, that are scheduled to be executed. This includes operations that update the cluster state (for example, a create index operation)

preparePendingClusterTasks

PendingClusterTasksRequestBuilder preparePendingClusterTasks()

Returns a list of the pending cluster tasks, that are scheduled to be executed. This includes operations that update the cluster state (for example, a create index operation)

snapshotsStatus

ActionFuture<SnapshotsStatusResponse> snapshotsStatus(SnapshotsStatusRequest request)

Get snapshot status.

snapshotsStatus

void snapshotsStatus(SnapshotsStatusRequest request,
                   ActionListener<SnapshotsStatusResponse> listener)

Get snapshot status.

prepareSnapshotStatus

SnapshotsStatusRequestBuilder prepareSnapshotStatus(String repository)

Get snapshot status.

prepareSnapshotStatus

SnapshotsStatusRequestBuilder prepareSnapshotStatus()

Get snapshot status.

renderSearchTemplate

ActionFuture<RenderSearchTemplateResponse> renderSearchTemplate(RenderSearchTemplateRequest request)

Return the rendered search request for a given search template.

Parameters:

request - The request

Returns:

The result future

renderSearchTemplate

void renderSearchTemplate(RenderSearchTemplateRequest request,
                        ActionListener<RenderSearchTemplateResponse> listener)

Return the rendered search request for a given search template.

Parameters:

request - The request

listener - A listener to be notified of the result

prepareRenderSearchTemplate

RenderSearchTemplateRequestBuilder prepareRenderSearchTemplate()

Return the rendered search request for a given search template.