Package org.opensearch.client

Interface ClusterAdminClient

All Superinterfaces:

OpenSearchClient

@PublicApi(since="1.0.0")
public interface ClusterAdminClient
extends OpenSearchClient

Administrative actions/operations against indices.

See Also:

• AdminClient.cluster()

Opensearch.api:

Method Summary

Modifier and Type	Method	Description
org.opensearch.common.action.ActionFuture<ClusterAllocationExplainResponse>	allocationExplain(ClusterAllocationExplainRequest request)	Explain the allocation of a shard
void	allocationExplain(ClusterAllocationExplainRequest request, org.opensearch.core.action.ActionListener<ClusterAllocationExplainResponse> listener)	Explain the allocation of a shard
org.opensearch.common.action.ActionFuture<CancelTasksResponse>	cancelTasks(CancelTasksRequest request)	Cancel tasks
void	cancelTasks(CancelTasksRequest request, org.opensearch.core.action.ActionListener<CancelTasksResponse> listener)	Cancel active tasks
org.opensearch.common.action.ActionFuture<CleanupRepositoryResponse>	cleanupRepository(CleanupRepositoryRequest repository)	Cleans up repository.
void	cleanupRepository(CleanupRepositoryRequest repository, org.opensearch.core.action.ActionListener<CleanupRepositoryResponse> listener)	Cleans up repository.
org.opensearch.common.action.ActionFuture<AcknowledgedResponse>	cloneSnapshot(CloneSnapshotRequest request)	Clones a snapshot.
void	cloneSnapshot(CloneSnapshotRequest request, org.opensearch.core.action.ActionListener<AcknowledgedResponse> listener)	Clones a snapshot.
org.opensearch.common.action.ActionFuture<ClusterStatsResponse>	clusterStats(ClusterStatsRequest request)	Cluster wide aggregated stats.
void	clusterStats(ClusterStatsRequest request, org.opensearch.core.action.ActionListener<ClusterStatsResponse> listener)	Cluster wide aggregated stats
org.opensearch.common.action.ActionFuture<CreateSnapshotResponse>	createSnapshot(CreateSnapshotRequest request)	Creates a new snapshot.
void	createSnapshot(CreateSnapshotRequest request, org.opensearch.core.action.ActionListener<CreateSnapshotResponse> listener)	Creates a new snapshot.
org.opensearch.common.action.ActionFuture<DecommissionResponse>	decommission(DecommissionRequest request)	Decommission awareness attribute
void	decommission(DecommissionRequest request, org.opensearch.core.action.ActionListener<DecommissionResponse> listener)	Decommission awareness attribute
org.opensearch.common.action.ActionFuture<AcknowledgedResponse>	deleteDanglingIndex(DeleteDanglingIndexRequest request)	Delete specified dangling indices.
void	deleteDanglingIndex(DeleteDanglingIndexRequest request, org.opensearch.core.action.ActionListener<AcknowledgedResponse> listener)	Delete specified dangling indices.
org.opensearch.common.action.ActionFuture<DeleteDecommissionStateResponse>	deleteDecommissionState(DeleteDecommissionStateRequest request)	Deletes the decommission metadata.
void	deleteDecommissionState(DeleteDecommissionStateRequest request, org.opensearch.core.action.ActionListener<DeleteDecommissionStateResponse> listener)	Deletes the decommission metadata.
org.opensearch.common.action.ActionFuture<AcknowledgedResponse>	deletePipeline(DeletePipelineRequest request)	Deletes a stored ingest pipeline
void	deletePipeline(DeletePipelineRequest request, org.opensearch.core.action.ActionListener<AcknowledgedResponse> listener)	Deletes a stored ingest pipeline
org.opensearch.common.action.ActionFuture<AcknowledgedResponse>	deleteRepository(DeleteRepositoryRequest request)	Unregisters a repository.
void	deleteRepository(DeleteRepositoryRequest request, org.opensearch.core.action.ActionListener<AcknowledgedResponse> listener)	Unregisters a repository.
org.opensearch.common.action.ActionFuture<AcknowledgedResponse>	deleteSearchPipeline(DeleteSearchPipelineRequest request)	Deletes a stored search pipeline
void	deleteSearchPipeline(DeleteSearchPipelineRequest request, org.opensearch.core.action.ActionListener<AcknowledgedResponse> listener)	Deletes a stored search pipeline
org.opensearch.common.action.ActionFuture<AcknowledgedResponse>	deleteSnapshot(DeleteSnapshotRequest request)	Delete snapshot.
void	deleteSnapshot(DeleteSnapshotRequest request, org.opensearch.core.action.ActionListener<AcknowledgedResponse> listener)	Delete snapshot.
org.opensearch.common.action.ActionFuture<AcknowledgedResponse>	deleteStoredScript(DeleteStoredScriptRequest request)	Delete a script from the cluster state
void	deleteStoredScript(DeleteStoredScriptRequest request, org.opensearch.core.action.ActionListener<AcknowledgedResponse> listener)	Delete a script from the cluster state
org.opensearch.common.action.ActionFuture<ClusterDeleteWeightedRoutingResponse>	deleteWeightedRouting(ClusterDeleteWeightedRoutingRequest request)	Deletes weights for weighted round-robin search routing policy.
void	deleteWeightedRouting(ClusterDeleteWeightedRoutingRequest request, org.opensearch.core.action.ActionListener<ClusterDeleteWeightedRoutingResponse> listener)	Deletes weights for weighted round-robin search routing policy.
org.opensearch.common.action.ActionFuture<GetDecommissionStateResponse>	getDecommissionState(GetDecommissionStateRequest request)	Get Decommissioned attribute
void	getDecommissionState(GetDecommissionStateRequest request, org.opensearch.core.action.ActionListener<GetDecommissionStateResponse> listener)	Get Decommissioned attribute
org.opensearch.common.action.ActionFuture<GetPipelineResponse>	getPipeline(GetPipelineRequest request)	Returns a stored ingest pipeline
void	getPipeline(GetPipelineRequest request, org.opensearch.core.action.ActionListener<GetPipelineResponse> listener)	Returns a stored ingest pipeline
org.opensearch.common.action.ActionFuture<GetRepositoriesResponse>	getRepositories(GetRepositoriesRequest request)	Gets repositories.
void	getRepositories(GetRepositoriesRequest request, org.opensearch.core.action.ActionListener<GetRepositoriesResponse> listener)	Gets repositories.
org.opensearch.common.action.ActionFuture<GetSearchPipelineResponse>	getSearchPipeline(GetSearchPipelineRequest request)	Returns a stored search pipeline
void	getSearchPipeline(GetSearchPipelineRequest request, org.opensearch.core.action.ActionListener<GetSearchPipelineResponse> listener)	Returns a stored search pipeline
org.opensearch.common.action.ActionFuture<GetSnapshotsResponse>	getSnapshots(GetSnapshotsRequest request)	Get snapshots.
void	getSnapshots(GetSnapshotsRequest request, org.opensearch.core.action.ActionListener<GetSnapshotsResponse> listener)	Get snapshot.
org.opensearch.common.action.ActionFuture<GetStoredScriptResponse>	getStoredScript(GetStoredScriptRequest request)	Get a script from the cluster state
void	getStoredScript(GetStoredScriptRequest request, org.opensearch.core.action.ActionListener<GetStoredScriptResponse> listener)	Get a script from the cluster state
org.opensearch.common.action.ActionFuture<GetTaskResponse>	getTask(GetTaskRequest request)	Get a task.
void	getTask(GetTaskRequest request, org.opensearch.core.action.ActionListener<GetTaskResponse> listener)	Get a task.
org.opensearch.common.action.ActionFuture<ClusterGetWeightedRoutingResponse>	getWeightedRouting(ClusterGetWeightedRoutingRequest request)	Gets weights for weighted round-robin search routing policy.
void	getWeightedRouting(ClusterGetWeightedRoutingRequest request, org.opensearch.core.action.ActionListener<ClusterGetWeightedRoutingResponse> listener)	Gets weights for weighted round-robin search routing policy.
org.opensearch.common.action.ActionFuture<ClusterHealthResponse>	health(ClusterHealthRequest request)	The health of the cluster.
void	health(ClusterHealthRequest request, org.opensearch.core.action.ActionListener<ClusterHealthResponse> listener)	The health of the cluster.
org.opensearch.common.action.ActionFuture<AcknowledgedResponse>	importDanglingIndex(ImportDanglingIndexRequest request)	Restore specified dangling indices.
void	importDanglingIndex(ImportDanglingIndexRequest request, org.opensearch.core.action.ActionListener<AcknowledgedResponse> listener)	Restore specified dangling indices.
org.opensearch.common.action.ActionFuture<ListDanglingIndicesResponse>	listDanglingIndices(ListDanglingIndicesRequest request)	List dangling indices on all nodes.
void	listDanglingIndices(ListDanglingIndicesRequest request, org.opensearch.core.action.ActionListener<ListDanglingIndicesResponse> listener)	List dangling indices on all nodes.
org.opensearch.common.action.ActionFuture<ListTasksResponse>	listTasks(ListTasksRequest request)	List tasks
void	listTasks(ListTasksRequest request, org.opensearch.core.action.ActionListener<ListTasksResponse> listener)	List active tasks
org.opensearch.common.action.ActionFuture<NodesHotThreadsResponse>	nodesHotThreads(NodesHotThreadsRequest request)	Returns top N hot-threads samples per node.
void	nodesHotThreads(NodesHotThreadsRequest request, org.opensearch.core.action.ActionListener<NodesHotThreadsResponse> listener)	Returns top N hot-threads samples per node.
org.opensearch.common.action.ActionFuture<NodesInfoResponse>	nodesInfo(NodesInfoRequest request)	Nodes info of the cluster.
void	nodesInfo(NodesInfoRequest request, org.opensearch.core.action.ActionListener<NodesInfoResponse> listener)	Nodes info of the cluster.
org.opensearch.common.action.ActionFuture<NodesStatsResponse>	nodesStats(NodesStatsRequest request)	Nodes stats of the cluster.
void	nodesStats(NodesStatsRequest request, org.opensearch.core.action.ActionListener<NodesStatsResponse> listener)	Nodes stats of the cluster.
org.opensearch.common.action.ActionFuture<NodesUsageResponse>	nodesUsage(NodesUsageRequest request)	Returns top N hot-threads samples per node.
void	nodesUsage(NodesUsageRequest request, org.opensearch.core.action.ActionListener<NodesUsageResponse> listener)	Nodes usage of the cluster.
org.opensearch.common.action.ActionFuture<PendingClusterTasksResponse>	pendingClusterTasks(PendingClusterTasksRequest request)	Returns a list of the pending cluster tasks, that are scheduled to be executed.
void	pendingClusterTasks(PendingClusterTasksRequest request, org.opensearch.core.action.ActionListener<PendingClusterTasksResponse> listener)	Returns a list of the pending cluster tasks, that are scheduled to be executed.
ClusterAllocationExplainRequestBuilder	prepareAllocationExplain()	Explain the allocation of a shard
CancelTasksRequestBuilder	prepareCancelTasks(String... nodesIds)	Cancel active tasks
CleanupRepositoryRequestBuilder	prepareCleanupRepository(String repository)	Cleans up repository.
CloneSnapshotRequestBuilder	prepareCloneSnapshot(String repository, String source, String target)	Clones a snapshot.
ClusterStatsRequestBuilder	prepareClusterStats()
CreateSnapshotRequestBuilder	prepareCreateSnapshot(String repository, String name)	Creates a new snapshot.
DecommissionRequestBuilder	prepareDecommission(DecommissionRequest request)	Decommission awareness attribute
DeleteDecommissionStateRequestBuilder	prepareDeleteDecommissionRequest()	Deletes the decommission metadata.
DeletePipelineRequestBuilder	prepareDeletePipeline()	Deletes a stored ingest pipeline
DeletePipelineRequestBuilder	prepareDeletePipeline(String id)	Deletes a stored ingest pipeline
DeleteRepositoryRequestBuilder	prepareDeleteRepository(String name)	Unregisters a repository.
DeleteSnapshotRequestBuilder	prepareDeleteSnapshot(String repository, String... snapshot)	Delete snapshot.
DeleteStoredScriptRequestBuilder	prepareDeleteStoredScript()	Delete a script from the cluster state
DeleteStoredScriptRequestBuilder	prepareDeleteStoredScript(String id)	Delete a script from the cluster state
ClusterDeleteWeightedRoutingRequestBuilder	prepareDeleteWeightedRouting()	Deletes weights for weighted round-robin search routing policy.
GetDecommissionStateRequestBuilder	prepareGetDecommissionState()	Get Decommissioned attribute
GetPipelineRequestBuilder	prepareGetPipeline(String... ids)	Returns a stored ingest pipeline
GetRepositoriesRequestBuilder	prepareGetRepositories(String... name)	Gets repositories.
GetSnapshotsRequestBuilder	prepareGetSnapshots(String repository)	Get snapshot.
GetStoredScriptRequestBuilder	prepareGetStoredScript()	Get a script from the cluster state
GetStoredScriptRequestBuilder	prepareGetStoredScript(String id)	Get a script from the cluster state
GetTaskRequestBuilder	prepareGetTask(String taskId)	Fetch a task by id.
GetTaskRequestBuilder	prepareGetTask(org.opensearch.core.tasks.TaskId taskId)	Fetch a task by id.
ClusterGetWeightedRoutingRequestBuilder	prepareGetWeightedRouting()	Gets weights for weighted round-robin search routing policy.
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.
NodesUsageRequestBuilder	prepareNodesUsage(String... nodesIds)	Nodes usage of the cluster.
PendingClusterTasksRequestBuilder	preparePendingClusterTasks()	Returns a list of the pending cluster tasks, that are scheduled to be executed.
PutPipelineRequestBuilder	preparePutPipeline(String id, org.opensearch.core.common.bytes.BytesReference source, org.opensearch.core.xcontent.MediaType mediaType)	Stores an ingest pipeline
PutRepositoryRequestBuilder	preparePutRepository(String name)	Registers a snapshot repository.
PutStoredScriptRequestBuilder	preparePutStoredScript()	Store a script in the cluster state
NodesReloadSecureSettingsRequestBuilder	prepareReloadSecureSettings()	Re initialize each cluster node and pass them the secret store password.
RemoteStoreStatsRequestBuilder	prepareRemoteStoreStats(String index, String shardId)
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.
SimulatePipelineRequestBuilder	prepareSimulatePipeline(org.opensearch.core.common.bytes.BytesReference source, org.opensearch.core.xcontent.MediaType mediaType)	Simulates an ingest pipeline
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.
ClusterPutWeightedRoutingRequestBuilder	prepareWeightedRouting()	Updates weights for weighted round-robin search routing policy.
org.opensearch.common.action.ActionFuture<AcknowledgedResponse>	putPipeline(PutPipelineRequest request)	Stores an ingest pipeline
void	putPipeline(PutPipelineRequest request, org.opensearch.core.action.ActionListener<AcknowledgedResponse> listener)	Stores an ingest pipeline
org.opensearch.common.action.ActionFuture<AcknowledgedResponse>	putRepository(PutRepositoryRequest request)	Registers a snapshot repository.
void	putRepository(PutRepositoryRequest request, org.opensearch.core.action.ActionListener<AcknowledgedResponse> listener)	Registers a snapshot repository.
org.opensearch.common.action.ActionFuture<AcknowledgedResponse>	putSearchPipeline(PutSearchPipelineRequest request)	Stores a search pipeline
void	putSearchPipeline(PutSearchPipelineRequest request, org.opensearch.core.action.ActionListener<AcknowledgedResponse> listener)	Stores a search pipeline
org.opensearch.common.action.ActionFuture<AcknowledgedResponse>	putStoredScript(PutStoredScriptRequest request)	Store a script in the cluster state
void	putStoredScript(PutStoredScriptRequest request, org.opensearch.core.action.ActionListener<AcknowledgedResponse> listener)	Store a script in the cluster state
org.opensearch.common.action.ActionFuture<ClusterPutWeightedRoutingResponse>	putWeightedRouting(ClusterPutWeightedRoutingRequest request)	Updates weights for weighted round-robin search routing policy.
void	putWeightedRouting(ClusterPutWeightedRoutingRequest request, org.opensearch.core.action.ActionListener<ClusterPutWeightedRoutingResponse> listener)	Updates weights for weighted round-robin search routing policy.
void	remoteStoreStats(RemoteStoreStatsRequest request, org.opensearch.core.action.ActionListener<RemoteStoreStatsResponse> listener)
org.opensearch.common.action.ActionFuture<ClusterRerouteResponse>	reroute(ClusterRerouteRequest request)	Reroutes allocation of shards.
void	reroute(ClusterRerouteRequest request, org.opensearch.core.action.ActionListener<ClusterRerouteResponse> listener)	Reroutes allocation of shards.
void	restoreRemoteStore(RestoreRemoteStoreRequest request, org.opensearch.core.action.ActionListener<RestoreRemoteStoreResponse> listener)	Restores from remote store.
org.opensearch.common.action.ActionFuture<RestoreSnapshotResponse>	restoreSnapshot(RestoreSnapshotRequest request)	Restores a snapshot.
void	restoreSnapshot(RestoreSnapshotRequest request, org.opensearch.core.action.ActionListener<RestoreSnapshotResponse> listener)	Restores a snapshot.
org.opensearch.common.action.ActionFuture<ClusterSearchShardsResponse>	searchShards(ClusterSearchShardsRequest request)	Returns list of shards the given search would be executed on.
void	searchShards(ClusterSearchShardsRequest request, org.opensearch.core.action.ActionListener<ClusterSearchShardsResponse> listener)	Returns list of shards the given search would be executed on.
org.opensearch.common.action.ActionFuture<SimulatePipelineResponse>	simulatePipeline(SimulatePipelineRequest request)	Simulates an ingest pipeline
void	simulatePipeline(SimulatePipelineRequest request, org.opensearch.core.action.ActionListener<SimulatePipelineResponse> listener)	Simulates an ingest pipeline
org.opensearch.common.action.ActionFuture<SnapshotsStatusResponse>	snapshotsStatus(SnapshotsStatusRequest request)	Get snapshot status.
void	snapshotsStatus(SnapshotsStatusRequest request, org.opensearch.core.action.ActionListener<SnapshotsStatusResponse> listener)	Get snapshot status.
org.opensearch.common.action.ActionFuture<ClusterStateResponse>	state(ClusterStateRequest request)	The state of the cluster.
void	state(ClusterStateRequest request, org.opensearch.core.action.ActionListener<ClusterStateResponse> listener)	The state of the cluster.
org.opensearch.common.action.ActionFuture<ClusterUpdateSettingsResponse>	updateSettings(ClusterUpdateSettingsRequest request)	Updates settings in the cluster.
void	updateSettings(ClusterUpdateSettingsRequest request, org.opensearch.core.action.ActionListener<ClusterUpdateSettingsResponse> listener)	Update settings in the cluster.
org.opensearch.common.action.ActionFuture<VerifyRepositoryResponse>	verifyRepository(VerifyRepositoryRequest request)	Verifies a repository.
void	verifyRepository(VerifyRepositoryRequest request, org.opensearch.core.action.ActionListener<VerifyRepositoryResponse> listener)	Verifies a repository.

Methods inherited from interface org.opensearch.client.OpenSearchClient

execute, execute, threadPool

Method Details

health

org.opensearch.common.action.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,
 org.opensearch.core.action.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

org.opensearch.common.action.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,
 org.opensearch.core.action.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

org.opensearch.common.action.ActionFuture<ClusterUpdateSettingsResponse> updateSettings(ClusterUpdateSettingsRequest request)

Updates settings in the cluster.

updateSettings

void updateSettings(ClusterUpdateSettingsRequest request,
 org.opensearch.core.action.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

org.opensearch.common.action.ActionFuture<ClusterRerouteResponse> reroute(ClusterRerouteRequest request)

Reroutes allocation of shards. Advance API.

reroute

void reroute(ClusterRerouteRequest request,
 org.opensearch.core.action.ActionListener<ClusterRerouteResponse> listener)

Reroutes allocation of shards. Advance API.

prepareReroute

ClusterRerouteRequestBuilder prepareReroute()

Update settings in the cluster.

nodesInfo

org.opensearch.common.action.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,
 org.opensearch.core.action.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

org.opensearch.common.action.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,
 org.opensearch.core.action.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

org.opensearch.common.action.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,
 org.opensearch.core.action.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.

remoteStoreStats

void remoteStoreStats(RemoteStoreStatsRequest request,
 org.opensearch.core.action.ActionListener<RemoteStoreStatsResponse> listener)

prepareRemoteStoreStats

RemoteStoreStatsRequestBuilder prepareRemoteStoreStats(String index,
 String shardId)

nodesUsage

org.opensearch.common.action.ActionFuture<NodesUsageResponse> nodesUsage(NodesUsageRequest request)

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

void nodesUsage(NodesUsageRequest request,
 org.opensearch.core.action.ActionListener<NodesUsageResponse> listener)

Nodes usage of the cluster.

Parameters:

request - The nodes usage request

listener - A listener to be notified with a result

See Also:

• Requests.nodesUsageRequest(String...)

prepareNodesUsage

NodesUsageRequestBuilder prepareNodesUsage(String... nodesIds)

Nodes usage of the cluster.

nodesHotThreads

org.opensearch.common.action.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,
 org.opensearch.core.action.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

org.opensearch.common.action.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,
 org.opensearch.core.action.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

getTask

org.opensearch.common.action.ActionFuture<GetTaskResponse> getTask(GetTaskRequest request)

Get a task.

Parameters:

request - the request

Returns:

the result future

See Also:

• Requests.getTaskRequest()

getTask

void getTask(GetTaskRequest request,
 org.opensearch.core.action.ActionListener<GetTaskResponse> listener)

Get a task.

Parameters:

request - the request

listener - A listener to be notified with the result

See Also:

• Requests.getTaskRequest()

prepareGetTask

GetTaskRequestBuilder prepareGetTask(String taskId)

Fetch a task by id.

prepareGetTask

GetTaskRequestBuilder prepareGetTask(org.opensearch.core.tasks.TaskId taskId)

Fetch a task by id.

cancelTasks

org.opensearch.common.action.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,
 org.opensearch.core.action.ActionListener<CancelTasksResponse> listener)

Cancel active tasks

Parameters:

request - The nodes tasks request

listener - A listener to be notified with a result

See Also:

• Requests.cancelTasksRequest()

prepareCancelTasks

CancelTasksRequestBuilder prepareCancelTasks(String... nodesIds)

Cancel active tasks

searchShards

org.opensearch.common.action.ActionFuture<ClusterSearchShardsResponse> searchShards(ClusterSearchShardsRequest request)

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

searchShards

void searchShards(ClusterSearchShardsRequest request,
 org.opensearch.core.action.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

org.opensearch.common.action.ActionFuture<AcknowledgedResponse> putRepository(PutRepositoryRequest request)

Registers a snapshot repository.

putRepository

void putRepository(PutRepositoryRequest request,
 org.opensearch.core.action.ActionListener<AcknowledgedResponse> listener)

Registers a snapshot repository.

preparePutRepository

PutRepositoryRequestBuilder preparePutRepository(String name)

Registers a snapshot repository.

deleteRepository

org.opensearch.common.action.ActionFuture<AcknowledgedResponse> deleteRepository(DeleteRepositoryRequest request)

Unregisters a repository.

deleteRepository

void deleteRepository(DeleteRepositoryRequest request,
 org.opensearch.core.action.ActionListener<AcknowledgedResponse> listener)

Unregisters a repository.

prepareDeleteRepository

DeleteRepositoryRequestBuilder prepareDeleteRepository(String name)

Unregisters a repository.

getRepositories

org.opensearch.common.action.ActionFuture<GetRepositoriesResponse> getRepositories(GetRepositoriesRequest request)

Gets repositories.

getRepositories

void getRepositories(GetRepositoriesRequest request,
 org.opensearch.core.action.ActionListener<GetRepositoriesResponse> listener)

Gets repositories.

prepareGetRepositories

GetRepositoriesRequestBuilder prepareGetRepositories(String... name)

Gets repositories.

prepareCleanupRepository

CleanupRepositoryRequestBuilder prepareCleanupRepository(String repository)

Cleans up repository.

cleanupRepository

org.opensearch.common.action.ActionFuture<CleanupRepositoryResponse> cleanupRepository(CleanupRepositoryRequest repository)

Cleans up repository.

cleanupRepository

void cleanupRepository(CleanupRepositoryRequest repository,
 org.opensearch.core.action.ActionListener<CleanupRepositoryResponse> listener)

Cleans up repository.

verifyRepository

org.opensearch.common.action.ActionFuture<VerifyRepositoryResponse> verifyRepository(VerifyRepositoryRequest request)

Verifies a repository.

verifyRepository

void verifyRepository(VerifyRepositoryRequest request,
 org.opensearch.core.action.ActionListener<VerifyRepositoryResponse> listener)

Verifies a repository.

prepareVerifyRepository

VerifyRepositoryRequestBuilder prepareVerifyRepository(String name)

Verifies a repository.

createSnapshot

org.opensearch.common.action.ActionFuture<CreateSnapshotResponse> createSnapshot(CreateSnapshotRequest request)

Creates a new snapshot.

createSnapshot

void createSnapshot(CreateSnapshotRequest request,
 org.opensearch.core.action.ActionListener<CreateSnapshotResponse> listener)

Creates a new snapshot.

prepareCreateSnapshot

CreateSnapshotRequestBuilder prepareCreateSnapshot(String repository,
 String name)

Creates a new snapshot.

prepareCloneSnapshot

CloneSnapshotRequestBuilder prepareCloneSnapshot(String repository,
 String source,
 String target)

Clones a snapshot.

cloneSnapshot

org.opensearch.common.action.ActionFuture<AcknowledgedResponse> cloneSnapshot(CloneSnapshotRequest request)

Clones a snapshot.

cloneSnapshot

void cloneSnapshot(CloneSnapshotRequest request,
 org.opensearch.core.action.ActionListener<AcknowledgedResponse> listener)

Clones a snapshot.

getSnapshots

org.opensearch.common.action.ActionFuture<GetSnapshotsResponse> getSnapshots(GetSnapshotsRequest request)

Get snapshots.

getSnapshots

void getSnapshots(GetSnapshotsRequest request,
 org.opensearch.core.action.ActionListener<GetSnapshotsResponse> listener)

Get snapshot.

prepareGetSnapshots

GetSnapshotsRequestBuilder prepareGetSnapshots(String repository)

Get snapshot.

deleteSnapshot

org.opensearch.common.action.ActionFuture<AcknowledgedResponse> deleteSnapshot(DeleteSnapshotRequest request)

Delete snapshot.

deleteSnapshot

void deleteSnapshot(DeleteSnapshotRequest request,
 org.opensearch.core.action.ActionListener<AcknowledgedResponse> listener)

Delete snapshot.

prepareDeleteSnapshot

DeleteSnapshotRequestBuilder prepareDeleteSnapshot(String repository,
 String... snapshot)

Delete snapshot.

restoreSnapshot

org.opensearch.common.action.ActionFuture<RestoreSnapshotResponse> restoreSnapshot(RestoreSnapshotRequest request)

Restores a snapshot.

restoreSnapshot

void restoreSnapshot(RestoreSnapshotRequest request,
 org.opensearch.core.action.ActionListener<RestoreSnapshotResponse> listener)

Restores a snapshot.

restoreRemoteStore

void restoreRemoteStore(RestoreRemoteStoreRequest request,
 org.opensearch.core.action.ActionListener<RestoreRemoteStoreResponse> listener)

Restores from remote store.

prepareRestoreSnapshot

RestoreSnapshotRequestBuilder prepareRestoreSnapshot(String repository,
 String snapshot)

Restores a snapshot.

pendingClusterTasks

void pendingClusterTasks(PendingClusterTasksRequest request,
 org.opensearch.core.action.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

org.opensearch.common.action.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

org.opensearch.common.action.ActionFuture<SnapshotsStatusResponse> snapshotsStatus(SnapshotsStatusRequest request)

Get snapshot status.

snapshotsStatus

void snapshotsStatus(SnapshotsStatusRequest request,
 org.opensearch.core.action.ActionListener<SnapshotsStatusResponse> listener)

Get snapshot status.

prepareSnapshotStatus

SnapshotsStatusRequestBuilder prepareSnapshotStatus(String repository)

Get snapshot status.

prepareSnapshotStatus

SnapshotsStatusRequestBuilder prepareSnapshotStatus()

Get snapshot status.

putPipeline

void putPipeline(PutPipelineRequest request,
 org.opensearch.core.action.ActionListener<AcknowledgedResponse> listener)

Stores an ingest pipeline

putPipeline

org.opensearch.common.action.ActionFuture<AcknowledgedResponse> putPipeline(PutPipelineRequest request)

Stores an ingest pipeline

preparePutPipeline

PutPipelineRequestBuilder preparePutPipeline(String id,
 org.opensearch.core.common.bytes.BytesReference source,
 org.opensearch.core.xcontent.MediaType mediaType)

Stores an ingest pipeline

deletePipeline

void deletePipeline(DeletePipelineRequest request,
 org.opensearch.core.action.ActionListener<AcknowledgedResponse> listener)

Deletes a stored ingest pipeline

deletePipeline

org.opensearch.common.action.ActionFuture<AcknowledgedResponse> deletePipeline(DeletePipelineRequest request)

Deletes a stored ingest pipeline

prepareDeletePipeline

DeletePipelineRequestBuilder prepareDeletePipeline()

Deletes a stored ingest pipeline

prepareDeletePipeline

DeletePipelineRequestBuilder prepareDeletePipeline(String id)

Deletes a stored ingest pipeline

getPipeline

void getPipeline(GetPipelineRequest request,
 org.opensearch.core.action.ActionListener<GetPipelineResponse> listener)

Returns a stored ingest pipeline

getPipeline

org.opensearch.common.action.ActionFuture<GetPipelineResponse> getPipeline(GetPipelineRequest request)

Returns a stored ingest pipeline

prepareGetPipeline

GetPipelineRequestBuilder prepareGetPipeline(String... ids)

Returns a stored ingest pipeline

simulatePipeline

void simulatePipeline(SimulatePipelineRequest request,
 org.opensearch.core.action.ActionListener<SimulatePipelineResponse> listener)

Simulates an ingest pipeline

simulatePipeline

org.opensearch.common.action.ActionFuture<SimulatePipelineResponse> simulatePipeline(SimulatePipelineRequest request)

Simulates an ingest pipeline

prepareSimulatePipeline

SimulatePipelineRequestBuilder prepareSimulatePipeline(org.opensearch.core.common.bytes.BytesReference source,
 org.opensearch.core.xcontent.MediaType mediaType)

Simulates an ingest pipeline

allocationExplain

void allocationExplain(ClusterAllocationExplainRequest request,
 org.opensearch.core.action.ActionListener<ClusterAllocationExplainResponse> listener)

Explain the allocation of a shard

allocationExplain

org.opensearch.common.action.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,
 org.opensearch.core.action.ActionListener<AcknowledgedResponse> listener)

Delete a script from the cluster state

deleteStoredScript

org.opensearch.common.action.ActionFuture<AcknowledgedResponse> deleteStoredScript(DeleteStoredScriptRequest request)

Delete a script from the cluster state

prepareDeleteStoredScript

DeleteStoredScriptRequestBuilder prepareDeleteStoredScript()

Delete a script from the cluster state

prepareDeleteStoredScript

DeleteStoredScriptRequestBuilder prepareDeleteStoredScript(String id)

Delete a script from the cluster state

putStoredScript

void putStoredScript(PutStoredScriptRequest request,
 org.opensearch.core.action.ActionListener<AcknowledgedResponse> listener)

Store a script in the cluster state

putStoredScript

org.opensearch.common.action.ActionFuture<AcknowledgedResponse> putStoredScript(PutStoredScriptRequest request)

Store a script in the cluster state

prepareGetStoredScript

GetStoredScriptRequestBuilder prepareGetStoredScript()

Get a script from the cluster state

prepareGetStoredScript

GetStoredScriptRequestBuilder prepareGetStoredScript(String id)

Get a script from the cluster state

getStoredScript

void getStoredScript(GetStoredScriptRequest request,
 org.opensearch.core.action.ActionListener<GetStoredScriptResponse> listener)

Get a script from the cluster state

getStoredScript

org.opensearch.common.action.ActionFuture<GetStoredScriptResponse> getStoredScript(GetStoredScriptRequest request)

Get a script from the cluster state

listDanglingIndices

void listDanglingIndices(ListDanglingIndicesRequest request,
 org.opensearch.core.action.ActionListener<ListDanglingIndicesResponse> listener)

List dangling indices on all nodes.

listDanglingIndices

org.opensearch.common.action.ActionFuture<ListDanglingIndicesResponse> listDanglingIndices(ListDanglingIndicesRequest request)

List dangling indices on all nodes.

importDanglingIndex

void importDanglingIndex(ImportDanglingIndexRequest request,
 org.opensearch.core.action.ActionListener<AcknowledgedResponse> listener)

Restore specified dangling indices.

importDanglingIndex

org.opensearch.common.action.ActionFuture<AcknowledgedResponse> importDanglingIndex(ImportDanglingIndexRequest request)

Restore specified dangling indices.

deleteDanglingIndex

void deleteDanglingIndex(DeleteDanglingIndexRequest request,
 org.opensearch.core.action.ActionListener<AcknowledgedResponse> listener)

Delete specified dangling indices.

deleteDanglingIndex

org.opensearch.common.action.ActionFuture<AcknowledgedResponse> deleteDanglingIndex(DeleteDanglingIndexRequest request)

Delete specified dangling indices.

putWeightedRouting

org.opensearch.common.action.ActionFuture<ClusterPutWeightedRoutingResponse> putWeightedRouting(ClusterPutWeightedRoutingRequest request)

Updates weights for weighted round-robin search routing policy.

putWeightedRouting

void putWeightedRouting(ClusterPutWeightedRoutingRequest request,
 org.opensearch.core.action.ActionListener<ClusterPutWeightedRoutingResponse> listener)

Updates weights for weighted round-robin search routing policy.

prepareWeightedRouting

ClusterPutWeightedRoutingRequestBuilder prepareWeightedRouting()

Updates weights for weighted round-robin search routing policy.

getWeightedRouting

org.opensearch.common.action.ActionFuture<ClusterGetWeightedRoutingResponse> getWeightedRouting(ClusterGetWeightedRoutingRequest request)

Gets weights for weighted round-robin search routing policy.

getWeightedRouting

void getWeightedRouting(ClusterGetWeightedRoutingRequest request,
 org.opensearch.core.action.ActionListener<ClusterGetWeightedRoutingResponse> listener)

Gets weights for weighted round-robin search routing policy.

prepareGetWeightedRouting

ClusterGetWeightedRoutingRequestBuilder prepareGetWeightedRouting()

Gets weights for weighted round-robin search routing policy.

deleteWeightedRouting

org.opensearch.common.action.ActionFuture<ClusterDeleteWeightedRoutingResponse> deleteWeightedRouting(ClusterDeleteWeightedRoutingRequest request)

Deletes weights for weighted round-robin search routing policy.

deleteWeightedRouting

void deleteWeightedRouting(ClusterDeleteWeightedRoutingRequest request,
 org.opensearch.core.action.ActionListener<ClusterDeleteWeightedRoutingResponse> listener)

Deletes weights for weighted round-robin search routing policy.

prepareDeleteWeightedRouting

ClusterDeleteWeightedRoutingRequestBuilder prepareDeleteWeightedRouting()

Deletes weights for weighted round-robin search routing policy.

decommission

org.opensearch.common.action.ActionFuture<DecommissionResponse> decommission(DecommissionRequest request)

Decommission awareness attribute

decommission

void decommission(DecommissionRequest request,
 org.opensearch.core.action.ActionListener<DecommissionResponse> listener)

Decommission awareness attribute

prepareDecommission

DecommissionRequestBuilder prepareDecommission(DecommissionRequest request)

Decommission awareness attribute

getDecommissionState

org.opensearch.common.action.ActionFuture<GetDecommissionStateResponse> getDecommissionState(GetDecommissionStateRequest request)

Get Decommissioned attribute

getDecommissionState

void getDecommissionState(GetDecommissionStateRequest request,
 org.opensearch.core.action.ActionListener<GetDecommissionStateResponse> listener)

Get Decommissioned attribute

prepareGetDecommissionState

GetDecommissionStateRequestBuilder prepareGetDecommissionState()

Get Decommissioned attribute

deleteDecommissionState

org.opensearch.common.action.ActionFuture<DeleteDecommissionStateResponse> deleteDecommissionState(DeleteDecommissionStateRequest request)

Deletes the decommission metadata.

deleteDecommissionState

void deleteDecommissionState(DeleteDecommissionStateRequest request,
 org.opensearch.core.action.ActionListener<DeleteDecommissionStateResponse> listener)

Deletes the decommission metadata.

prepareDeleteDecommissionRequest

DeleteDecommissionStateRequestBuilder prepareDeleteDecommissionRequest()

Deletes the decommission metadata.

putSearchPipeline

void putSearchPipeline(PutSearchPipelineRequest request,
 org.opensearch.core.action.ActionListener<AcknowledgedResponse> listener)

Stores a search pipeline

putSearchPipeline

org.opensearch.common.action.ActionFuture<AcknowledgedResponse> putSearchPipeline(PutSearchPipelineRequest request)

Stores a search pipeline

getSearchPipeline

void getSearchPipeline(GetSearchPipelineRequest request,
 org.opensearch.core.action.ActionListener<GetSearchPipelineResponse> listener)

Returns a stored search pipeline

getSearchPipeline

org.opensearch.common.action.ActionFuture<GetSearchPipelineResponse> getSearchPipeline(GetSearchPipelineRequest request)

Returns a stored search pipeline

deleteSearchPipeline

void deleteSearchPipeline(DeleteSearchPipelineRequest request,
 org.opensearch.core.action.ActionListener<AcknowledgedResponse> listener)

Deletes a stored search pipeline

deleteSearchPipeline

org.opensearch.common.action.ActionFuture<AcknowledgedResponse> deleteSearchPipeline(DeleteSearchPipelineRequest request)

Deletes a stored search pipeline