Package 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 inherited from interface org.elasticsearch.client.ElasticsearchClient
execute, execute, threadPool
-
Method Details
-
health
The health of the cluster.- Parameters:
request
- The cluster state request- Returns:
- The result future
- See Also:
Requests.clusterHealthRequest(String...)
-
health
The health of the cluster.- Parameters:
request
- The cluster state requestlistener
- A listener to be notified with a result- See Also:
Requests.clusterHealthRequest(String...)
-
prepareHealth
The health of the cluster. -
state
The state of the cluster.- Parameters:
request
- The cluster state request.- Returns:
- The result future
- See Also:
Requests.clusterStateRequest()
-
state
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
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
- See Also:
Requests.nodesInfoRequest(String...)
-
nodesInfo
Nodes info of the cluster.- Parameters:
request
- The nodes info requestlistener
- A listener to be notified with a result- See Also:
Requests.nodesInfoRequest(String...)
-
prepareNodesInfo
Nodes info of the cluster. -
clusterStats
Cluster wide aggregated stats.- Parameters:
request
- The cluster stats request- Returns:
- The result future
- See Also:
Requests.clusterStatsRequest()
-
clusterStats
Cluster wide aggregated stats- Parameters:
request
- The cluster stats requestlistener
- A listener to be notified with a result- See Also:
Requests.clusterStatsRequest()
-
prepareClusterStats
ClusterStatsRequestBuilder prepareClusterStats() -
nodesStats
Nodes stats of the cluster.- Parameters:
request
- The nodes stats request- Returns:
- The result future
- See Also:
Requests.nodesStatsRequest(String...)
-
nodesStats
Nodes stats of the cluster.- Parameters:
request
- The nodes info requestlistener
- A listener to be notified with a result- See Also:
Requests.nodesStatsRequest(String...)
-
prepareNodesStats
Nodes stats of the cluster. -
nodesUsage
Returns top N hot-threads samples per node. The hot-threads are only sampled for the node ids specified in the request. Nodes usage of the cluster.- Parameters:
request
- The nodes usage request- Returns:
- The result future
- See Also:
Requests.nodesUsageRequest(String...)
-
nodesUsage
Nodes usage of the cluster.- Parameters:
request
- The nodes usage requestlistener
- A listener to be notified with a result- See Also:
Requests.nodesUsageRequest(String...)
-
prepareNodesUsage
Nodes usage of the cluster. -
nodesHotThreads
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
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
- See Also:
Requests.listTasksRequest()
-
listTasks
List active tasks- Parameters:
request
- The nodes tasks requestlistener
- A listener to be notified with a result- See Also:
Requests.listTasksRequest()
-
prepareListTasks
List active tasks -
getTask
Get a task.- Parameters:
request
- the request- Returns:
- the result future
- See Also:
Requests.getTaskRequest()
-
getTask
Get a task.- Parameters:
request
- the requestlistener
- A listener to be notified with the result- See Also:
Requests.getTaskRequest()
-
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
- See Also:
Requests.cancelTasksRequest()
-
cancelTasks
Cancel active tasks- Parameters:
request
- The nodes tasks requestlistener
- A listener to be notified with a result- See Also:
Requests.cancelTasksRequest()
-
prepareCancelTasks
Cancel active tasks -
searchShards
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
Returns list of shards the given search would be executed on. -
putRepository
Registers a snapshot repository. -
putRepository
Registers a snapshot repository. -
preparePutRepository
Registers a snapshot repository. -
deleteRepository
Unregisters a repository. -
deleteRepository
void deleteRepository(DeleteRepositoryRequest request, ActionListener<AcknowledgedResponse> listener)Unregisters a repository. -
prepareDeleteRepository
Unregisters a repository. -
getRepositories
Gets repositories. -
getRepositories
void getRepositories(GetRepositoriesRequest request, ActionListener<GetRepositoriesResponse> listener)Gets repositories. -
prepareGetRepositories
Gets repositories. -
prepareCleanupRepository
Cleans up repository. -
cleanupRepository
Cleans up repository. -
cleanupRepository
void cleanupRepository(CleanupRepositoryRequest repository, ActionListener<CleanupRepositoryResponse> listener)Cleans up repository. -
verifyRepository
Verifies a repository. -
verifyRepository
void verifyRepository(VerifyRepositoryRequest request, ActionListener<VerifyRepositoryResponse> listener)Verifies a repository. -
prepareVerifyRepository
Verifies a repository. -
createSnapshot
Creates a new snapshot. -
createSnapshot
void createSnapshot(CreateSnapshotRequest request, ActionListener<CreateSnapshotResponse> listener)Creates a new snapshot. -
prepareCreateSnapshot
CreateSnapshotRequestBuilder prepareCreateSnapshot(java.lang.String repository, java.lang.String name)Creates a new snapshot. -
getSnapshots
Get snapshot. -
getSnapshots
Get snapshot. -
prepareGetSnapshots
Get snapshot. -
deleteSnapshot
Delete snapshot. -
deleteSnapshot
Delete snapshot. -
prepareDeleteSnapshot
DeleteSnapshotRequestBuilder prepareDeleteSnapshot(java.lang.String repository, java.lang.String... snapshot)Delete snapshot. -
restoreSnapshot
Restores a snapshot. -
restoreSnapshot
void restoreSnapshot(RestoreSnapshotRequest request, ActionListener<RestoreSnapshotResponse> listener)Restores a snapshot. -
prepareRestoreSnapshot
RestoreSnapshotRequestBuilder prepareRestoreSnapshot(java.lang.String repository, java.lang.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
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
Get snapshot status. -
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(java.lang.String id, BytesReference source, org.elasticsearch.common.xcontent.XContentType xContentType)Stores an ingest pipeline -
deletePipeline
Deletes a stored ingest pipeline -
deletePipeline
Deletes a stored ingest pipeline -
prepareDeletePipeline
DeletePipelineRequestBuilder prepareDeletePipeline()Deletes a stored ingest pipeline -
prepareDeletePipeline
Deletes a stored ingest pipeline -
getPipeline
Returns 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, org.elasticsearch.common.xcontent.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 -
deleteStoredScript
Delete a script from the cluster state -
prepareDeleteStoredScript
DeleteStoredScriptRequestBuilder prepareDeleteStoredScript()Delete a script from the cluster state -
prepareDeleteStoredScript
Delete a script from the cluster state -
putStoredScript
void putStoredScript(PutStoredScriptRequest request, ActionListener<AcknowledgedResponse> listener)Store a script in the cluster state -
putStoredScript
Store a script in the cluster state -
prepareGetStoredScript
GetStoredScriptRequestBuilder prepareGetStoredScript()Get a script from 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 -
getStoredScript
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.
-