Module org.elasticsearch.server
Interface ClusterAdminClient
- All Superinterfaces:
ElasticsearchClient
Administrative actions/operations against indices.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionExplain the allocation of a shardvoid
allocationExplain
(ClusterAllocationExplainRequest request, ActionListener<ClusterAllocationExplainResponse> listener) Explain the allocation of a shardcancelTasks
(CancelTasksRequest request) Cancel tasksvoid
cancelTasks
(CancelTasksRequest request, ActionListener<CancelTasksResponse> listener) Cancel active tasksvoid
cleanupRepository
(CleanupRepositoryRequest repository, ActionListener<CleanupRepositoryResponse> listener) Cleans up repository.void
cloneSnapshot
(CloneSnapshotRequest request, ActionListener<AcknowledgedResponse> listener) Clones a snapshot.void
clusterStats
(ClusterStatsRequest request, ActionListener<ClusterStatsResponse> listener) Cluster wide aggregated statscreateSnapshot
(CreateSnapshotRequest request) Creates a new snapshot.void
createSnapshot
(CreateSnapshotRequest request, ActionListener<CreateSnapshotResponse> listener) Creates a new snapshot.Delete specified dangling indices.void
deleteDanglingIndex
(DeleteDanglingIndexRequest request, ActionListener<AcknowledgedResponse> listener) Delete specified dangling indices.deletePipeline
(DeletePipelineRequest request) Deletes a stored ingest pipelinevoid
deletePipeline
(DeletePipelineRequest request, ActionListener<AcknowledgedResponse> listener) Deletes a stored ingest pipelinevoid
deleteRepository
(DeleteRepositoryRequest request, ActionListener<AcknowledgedResponse> listener) Unregisters a repository.void
deleteSnapshot
(DeleteSnapshotRequest request, ActionListener<AcknowledgedResponse> listener) Delete snapshot.void
deleteStoredScript
(DeleteStoredScriptRequest request, ActionListener<AcknowledgedResponse> listener) Delete a script from the cluster statevoid
getPipeline
(GetPipelineRequest request, ActionListener<GetPipelineResponse> listener) Returns a stored ingest pipelinevoid
getRepositories
(GetRepositoriesRequest request, ActionListener<GetRepositoriesResponse> listener) Gets repositories.void
getSnapshots
(GetSnapshotsRequest request, ActionListener<GetSnapshotsResponse> listener) Get snapshots.void
getStoredScript
(GetStoredScriptRequest request, ActionListener<GetStoredScriptResponse> listener) Get a script from the cluster stategetTask
(GetTaskRequest request) Get a task.void
getTask
(GetTaskRequest request, ActionListener<GetTaskResponse> listener) Get a task.health
(ClusterHealthRequest request) The health of the cluster.void
health
(ClusterHealthRequest request, ActionListener<ClusterHealthResponse> listener) The health of the cluster.Restore specified dangling indices.void
importDanglingIndex
(ImportDanglingIndexRequest request, ActionListener<AcknowledgedResponse> listener) Restore specified dangling indices.List dangling indices on all nodes.void
listDanglingIndices
(ListDanglingIndicesRequest request, ActionListener<ListDanglingIndicesResponse> listener) List dangling indices on all nodes.listTasks
(ListTasksRequest request) List tasksvoid
listTasks
(ListTasksRequest request, ActionListener<ListTasksResponse> listener) List active tasksvoid
nodesHotThreads
(NodesHotThreadsRequest request, ActionListener<NodesHotThreadsResponse> listener) Returns top N hot-threads samples per node.nodesInfo
(NodesInfoRequest request) Nodes info of the cluster.void
nodesInfo
(NodesInfoRequest request, ActionListener<NodesInfoResponse> listener) Nodes info of the cluster.nodesStats
(NodesStatsRequest request) Nodes stats of the cluster.void
nodesStats
(NodesStatsRequest request, ActionListener<NodesStatsResponse> listener) Nodes stats of the cluster.void
nodesUsage
(NodesUsageRequest request, ActionListener<NodesUsageResponse> listener) Nodes usage of the cluster.void
pendingClusterTasks
(PendingClusterTasksRequest request, ActionListener<PendingClusterTasksResponse> listener) Returns a list of the pending cluster tasks, that are scheduled to be executed.Explain the allocation of a shardprepareCancelTasks
(String... nodesIds) Cancel active tasksprepareCleanupRepository
(String repository) Cleans up repository.prepareCloneSnapshot
(String repository, String source, String target) Clones a snapshot.prepareCreateSnapshot
(String repository, String name) Creates a new snapshot.Deletes a stored ingest pipelineUnregisters a repository.prepareDeleteSnapshot
(String repository, String... snapshot) Delete snapshot.Delete a script from the cluster stateprepareGetPipeline
(String... ids) Returns a stored ingest pipelineprepareGetRepositories
(String... name) Gets repositories.prepareGetSnapshots
(String... repository) Get snapshots.Get a script from the cluster stateprepareGetTask
(String taskId) Fetch a task by id.prepareGetTask
(TaskId taskId) Fetch a task by id.prepareHealth
(String... indices) The health of the cluster.prepareListTasks
(String... nodesIds) List active tasksprepareNodesHotThreads
(String... nodesIds) Returns a request builder to fetch top N hot-threads samples per node.prepareNodesInfo
(String... nodesIds) Nodes info of the cluster.prepareNodesStats
(String... nodesIds) Nodes stats of the cluster.Returns a list of the pending cluster tasks, that are scheduled to be executed.preparePutPipeline
(String id, BytesReference source, XContentType xContentType) Stores an ingest pipelinepreparePutRepository
(String name) Registers a snapshot repository.Store a script in the cluster stateRe initialize each cluster node and pass them the secret store password.Update settings in the cluster.prepareRestoreSnapshot
(String repository, String snapshot) Restores a snapshot.prepareSearchShards
(String... indices) Returns list of shards the given search would be executed on.prepareSimulatePipeline
(BytesReference source, XContentType xContentType) Simulates an ingest pipelineGet snapshot status.prepareSnapshotStatus
(String repository) Get snapshot status.The state of the cluster.Update settings in the cluster.Verifies a repository.putPipeline
(PutPipelineRequest request) Stores an ingest pipelinevoid
putPipeline
(PutPipelineRequest request, ActionListener<AcknowledgedResponse> listener) Stores an ingest pipelinevoid
putRepository
(PutRepositoryRequest request, ActionListener<AcknowledgedResponse> listener) Registers a snapshot repository.void
putStoredScript
(PutStoredScriptRequest request, ActionListener<AcknowledgedResponse> listener) Store a script in the cluster statereroute
(ClusterRerouteRequest request) Reroutes allocation of shards.void
reroute
(ClusterRerouteRequest request, ActionListener<ClusterRerouteResponse> listener) Reroutes allocation of shards.restoreSnapshot
(RestoreSnapshotRequest request) Restores a snapshot.void
restoreSnapshot
(RestoreSnapshotRequest request, ActionListener<RestoreSnapshotResponse> listener) Restores a snapshot.void
searchShards
(ClusterSearchShardsRequest request, ActionListener<ClusterSearchShardsResponse> listener) Returns list of shards the given search would be executed on.simulatePipeline
(SimulatePipelineRequest request) Simulates an ingest pipelinevoid
simulatePipeline
(SimulatePipelineRequest request, ActionListener<SimulatePipelineResponse> listener) Simulates an ingest pipelinevoid
snapshotsStatus
(SnapshotsStatusRequest request, ActionListener<SnapshotsStatusResponse> listener) Get snapshot status.state
(ClusterStateRequest request) The state of the cluster.void
state
(ClusterStateRequest request, ActionListener<ClusterStateResponse> listener) The state of the cluster.Updates settings in the cluster.void
updateSettings
(ClusterUpdateSettingsRequest request, ActionListener<ClusterUpdateSettingsResponse> listener) Update settings in the cluster.void
verifyRepository
(VerifyRepositoryRequest request, ActionListener<VerifyRepositoryResponse> listener) Verifies a repository.Methods inherited from interface org.elasticsearch.client.internal.ElasticsearchClient
execute, execute, threadPool
-
Method Details
-
health
The health of the cluster.- Parameters:
request
- The cluster state request- Returns:
- The result future
-
health
The health of the cluster.- Parameters:
request
- The cluster state requestlistener
- A listener to be notified with a result
-
prepareHealth
The health of the cluster. -
state
The state of the cluster.- Parameters:
request
- The cluster state request.- Returns:
- The result future
-
state
The state of the cluster.- Parameters:
request
- The cluster state request.listener
- A listener to be notified with a result
-
prepareState
ClusterStateRequestBuilder prepareState()The state of the cluster. -
updateSettings
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. -
prepareReloadSecureSettings
NodesReloadSecureSettingsRequestBuilder prepareReloadSecureSettings()Re initialize each cluster node and pass them the secret store password. -
reroute
Reroutes allocation of shards. Advance API. -
reroute
Reroutes allocation of shards. Advance API. -
prepareReroute
ClusterRerouteRequestBuilder prepareReroute()Update settings in the cluster. -
nodesInfo
Nodes info of the cluster.- Parameters:
request
- The nodes info request- Returns:
- The result future
-
nodesInfo
Nodes info of the cluster.- Parameters:
request
- The nodes info requestlistener
- A listener to be notified with a result
-
prepareNodesInfo
Nodes info of the cluster. -
clusterStats
Cluster wide aggregated stats- Parameters:
request
- The cluster stats requestlistener
- A listener to be notified with a result
-
prepareClusterStats
ClusterStatsRequestBuilder prepareClusterStats() -
nodesStats
Nodes stats of the cluster.- Parameters:
request
- The nodes stats request- Returns:
- The result future
-
nodesStats
Nodes stats of the cluster.- Parameters:
request
- The nodes info requestlistener
- A listener to be notified with a result
-
prepareNodesStats
Nodes stats of the cluster. -
nodesUsage
Nodes usage of the cluster.- Parameters:
request
- The nodes usage requestlistener
- A listener to be notified with a result
-
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
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
List tasks- Parameters:
request
- The nodes tasks request- Returns:
- The result future
-
listTasks
List active tasks- Parameters:
request
- The nodes tasks requestlistener
- A listener to be notified with a result
-
prepareListTasks
List active tasks -
getTask
Get a task.- Parameters:
request
- the request- Returns:
- the result future
-
getTask
Get a task.- Parameters:
request
- the requestlistener
- A listener to be notified with the result
-
prepareGetTask
Fetch a task by id. -
prepareGetTask
Fetch a task by id. -
cancelTasks
Cancel tasks- Parameters:
request
- The nodes tasks request- Returns:
- The result future
-
cancelTasks
Cancel active tasks- Parameters:
request
- The nodes tasks requestlistener
- A listener to be notified with a result
-
prepareCancelTasks
Cancel active tasks -
searchShards
void searchShards(ClusterSearchShardsRequest request, ActionListener<ClusterSearchShardsResponse> listener) Returns list of shards the given search would be executed on. -
prepareSearchShards
Returns list of shards the given search would be executed on. -
putRepository
Registers a snapshot repository. -
preparePutRepository
Registers a snapshot repository. -
deleteRepository
void deleteRepository(DeleteRepositoryRequest request, ActionListener<AcknowledgedResponse> listener) Unregisters a repository. -
prepareDeleteRepository
Unregisters a repository. -
getRepositories
void getRepositories(GetRepositoriesRequest request, ActionListener<GetRepositoriesResponse> listener) Gets repositories. -
prepareGetRepositories
Gets repositories. -
prepareCleanupRepository
Cleans up repository. -
cleanupRepository
void cleanupRepository(CleanupRepositoryRequest repository, ActionListener<CleanupRepositoryResponse> listener) Cleans up repository. -
verifyRepository
void verifyRepository(VerifyRepositoryRequest request, ActionListener<VerifyRepositoryResponse> listener) Verifies a repository. -
prepareVerifyRepository
Verifies a repository. -
createSnapshot
Creates a new snapshot. -
createSnapshot
Creates a new snapshot. -
prepareCreateSnapshot
Creates a new snapshot. -
prepareCloneSnapshot
Clones a snapshot. -
cloneSnapshot
Clones a snapshot. -
getSnapshots
Get snapshots. -
prepareGetSnapshots
Get snapshots. -
deleteSnapshot
Delete snapshot. -
prepareDeleteSnapshot
Delete snapshot. -
restoreSnapshot
Restores a snapshot. -
restoreSnapshot
void restoreSnapshot(RestoreSnapshotRequest request, ActionListener<RestoreSnapshotResponse> listener) Restores a snapshot. -
prepareRestoreSnapshot
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) -
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
void snapshotsStatus(SnapshotsStatusRequest request, ActionListener<SnapshotsStatusResponse> listener) Get snapshot status. -
prepareSnapshotStatus
Get snapshot status. -
prepareSnapshotStatus
SnapshotsStatusRequestBuilder prepareSnapshotStatus()Get snapshot status. -
putPipeline
Stores an ingest pipeline -
putPipeline
Stores an ingest pipeline -
preparePutPipeline
PutPipelineRequestBuilder preparePutPipeline(String id, BytesReference source, XContentType xContentType) Stores an ingest pipeline -
deletePipeline
Deletes a stored ingest pipeline -
deletePipeline
Deletes a stored ingest pipeline -
prepareDeletePipeline
Deletes a stored ingest pipeline -
getPipeline
Returns a stored ingest pipeline -
prepareGetPipeline
Returns a stored ingest pipeline -
simulatePipeline
void simulatePipeline(SimulatePipelineRequest request, ActionListener<SimulatePipelineResponse> listener) Simulates an ingest pipeline -
simulatePipeline
Simulates an ingest pipeline -
prepareSimulatePipeline
SimulatePipelineRequestBuilder prepareSimulatePipeline(BytesReference source, XContentType xContentType) Simulates an ingest pipeline -
allocationExplain
void allocationExplain(ClusterAllocationExplainRequest request, ActionListener<ClusterAllocationExplainResponse> listener) Explain the allocation of a shard -
allocationExplain
ActionFuture<ClusterAllocationExplainResponse> allocationExplain(ClusterAllocationExplainRequest request) Explain the allocation of a shard -
prepareAllocationExplain
ClusterAllocationExplainRequestBuilder prepareAllocationExplain()Explain the allocation of a shard -
preparePutStoredScript
PutStoredScriptRequestBuilder preparePutStoredScript()Store a script in the cluster state -
deleteStoredScript
void deleteStoredScript(DeleteStoredScriptRequest request, ActionListener<AcknowledgedResponse> listener) Delete a script from the cluster state -
prepareDeleteStoredScript
Delete a script from the cluster state -
putStoredScript
Store a script in the cluster state -
prepareGetStoredScript
Get a script from the cluster state -
getStoredScript
void getStoredScript(GetStoredScriptRequest request, ActionListener<GetStoredScriptResponse> listener) Get a script from the cluster state -
listDanglingIndices
void listDanglingIndices(ListDanglingIndicesRequest request, ActionListener<ListDanglingIndicesResponse> listener) List dangling indices on all nodes. -
listDanglingIndices
List dangling indices on all nodes. -
importDanglingIndex
void importDanglingIndex(ImportDanglingIndexRequest request, ActionListener<AcknowledgedResponse> listener) Restore specified dangling indices. -
importDanglingIndex
Restore specified dangling indices. -
deleteDanglingIndex
void deleteDanglingIndex(DeleteDanglingIndexRequest request, ActionListener<AcknowledgedResponse> listener) Delete specified dangling indices. -
deleteDanglingIndex
Delete specified dangling indices.
-