Module org.elasticsearch.server

Package org.elasticsearch.client.internal

Class ClusterAdminClient

java.lang.Object

org.elasticsearch.client.internal.ClusterAdminClient

All Implemented Interfaces:

ElasticsearchClient

public class ClusterAdminClient
extends Object
implements ElasticsearchClient

Administrative actions/operations against indices.

See Also:

• AdminClient.cluster()

Field Summary

Fields

Modifier and Type	Field	Description
protected final ElasticsearchClient	client

Constructor Summary

Constructors

Constructor	Description
ClusterAdminClient(ElasticsearchClient client)

Method Summary

Modifier and Type	Method	Description
ActionFuture<ListTasksResponse>	cancelTasks(CancelTasksRequest request)
void	cancelTasks(CancelTasksRequest request, ActionListener<ListTasksResponse> listener)
void	cleanupRepository(CleanupRepositoryRequest request, ActionListener<CleanupRepositoryResponse> listener)
void	cloneSnapshot(CloneSnapshotRequest request, ActionListener<AcknowledgedResponse> listener)
void	clusterStats(ClusterStatsRequest request, ActionListener<ClusterStatsResponse> listener)
ActionFuture<CreateSnapshotResponse>	createSnapshot(CreateSnapshotRequest request)
void	createSnapshot(CreateSnapshotRequest request, ActionListener<CreateSnapshotResponse> listener)
ActionFuture<AcknowledgedResponse>	deletePipeline(DeletePipelineRequest request)
void	deletePipeline(DeletePipelineRequest request, ActionListener<AcknowledgedResponse> listener)
void	deleteRepository(DeleteRepositoryRequest request, ActionListener<AcknowledgedResponse> listener)
void	deleteSnapshot(DeleteSnapshotRequest request, ActionListener<AcknowledgedResponse> listener)
void	deleteStoredScript(DeleteStoredScriptRequest request, ActionListener<AcknowledgedResponse> listener)
<Request extends ActionRequest, Response extends ActionResponse> ActionFuture<Response>	execute(ActionType<Response> action, Request request)	Executes a generic action, denoted by an ActionType.
<Request extends ActionRequest, Response extends ActionResponse> void	execute(ActionType<Response> action, Request request, ActionListener<Response> listener)	Executes a generic action, denoted by an ActionType.
void	getPipeline(GetPipelineRequest request, ActionListener<GetPipelineResponse> listener)
void	getRepositories(GetRepositoriesRequest request, ActionListener<GetRepositoriesResponse> listener)
void	getSnapshots(GetSnapshotsRequest request, ActionListener<GetSnapshotsResponse> listener)
void	getStoredScript(GetStoredScriptRequest request, ActionListener<GetStoredScriptResponse> listener)
ActionFuture<GetTaskResponse>	getTask(GetTaskRequest request)
void	getTask(GetTaskRequest request, ActionListener<GetTaskResponse> listener)
ActionFuture<ClusterHealthResponse>	health(ClusterHealthRequest request)
void	health(ClusterHealthRequest request, ActionListener<ClusterHealthResponse> listener)
ActionFuture<ListTasksResponse>	listTasks(ListTasksRequest request)
void	listTasks(ListTasksRequest request, ActionListener<ListTasksResponse> listener)
ActionFuture<NodesCapabilitiesResponse>	nodesCapabilities(NodesCapabilitiesRequest request)
void	nodesCapabilities(NodesCapabilitiesRequest request, ActionListener<NodesCapabilitiesResponse> listener)
ActionFuture<NodesInfoResponse>	nodesInfo(NodesInfoRequest request)
void	nodesInfo(NodesInfoRequest request, ActionListener<NodesInfoResponse> listener)
ActionFuture<NodesStatsResponse>	nodesStats(NodesStatsRequest request)
void	nodesStats(NodesStatsRequest request, ActionListener<NodesStatsResponse> listener)
void	nodesUsage(NodesUsageRequest request, ActionListener<NodesUsageResponse> listener)
CancelTasksRequestBuilder	prepareCancelTasks(String... nodesIds)
CleanupRepositoryRequestBuilder	prepareCleanupRepository(TimeValue masterNodeTimeout, TimeValue ackTimeout, String repository)
CloneSnapshotRequestBuilder	prepareCloneSnapshot(TimeValue masterNodeTimeout, String repository, String source, String target)
ClusterStatsRequestBuilder	prepareClusterStats()
CreateSnapshotRequestBuilder	prepareCreateSnapshot(String repository, String name)	Deprecated, for removal: This API element is subject to removal in a future version.
CreateSnapshotRequestBuilder	prepareCreateSnapshot(TimeValue masterNodeTimeout, String repository, String name)
DeletePipelineRequestBuilder	prepareDeletePipeline(String id)
DeleteRepositoryRequestBuilder	prepareDeleteRepository(String name)	Deprecated, for removal: This API element is subject to removal in a future version.
DeleteRepositoryRequestBuilder	prepareDeleteRepository(TimeValue masterNodeTimeout, TimeValue ackTimeout, String name)
DeleteSnapshotRequestBuilder	prepareDeleteSnapshot(String repository, String... names)	Deprecated, for removal: This API element is subject to removal in a future version.
DeleteSnapshotRequestBuilder	prepareDeleteSnapshot(TimeValue masterNodeTimeout, String repository, String... names)
DeleteStoredScriptRequestBuilder	prepareDeleteStoredScript(String id)
GetPipelineRequestBuilder	prepareGetPipeline(String... ids)
GetRepositoriesRequestBuilder	prepareGetRepositories(TimeValue masterNodeTimeout, String... name)
GetSnapshotsRequestBuilder	prepareGetSnapshots(String... repositories)	Deprecated, for removal: This API element is subject to removal in a future version.
GetSnapshotsRequestBuilder	prepareGetSnapshots(TimeValue masterNodeTimeout, String... repositories)
GetStoredScriptRequestBuilder	prepareGetStoredScript(String id)
GetTaskRequestBuilder	prepareGetTask(String taskId)
GetTaskRequestBuilder	prepareGetTask(TaskId taskId)
ClusterHealthRequestBuilder	prepareHealth(String... indices)
ListTasksRequestBuilder	prepareListTasks(String... nodesIds)
NodesInfoRequestBuilder	prepareNodesInfo(String... nodesIds)
NodesStatsRequestBuilder	prepareNodesStats(String... nodesIds)
PutPipelineRequestBuilder	preparePutPipeline(String id, BytesReference source, XContentType xContentType)
PutRepositoryRequestBuilder	preparePutRepository(String name)	Deprecated, for removal: This API element is subject to removal in a future version.
PutRepositoryRequestBuilder	preparePutRepository(TimeValue masterNodeTimeout, TimeValue ackTimeout, String name)
PutStoredScriptRequestBuilder	preparePutStoredScript()
RestoreSnapshotRequestBuilder	prepareRestoreSnapshot(String repository, String snapshot)	Deprecated, for removal: This API element is subject to removal in a future version.
RestoreSnapshotRequestBuilder	prepareRestoreSnapshot(TimeValue masterNodeTimeout, String repository, String snapshot)
ClusterSearchShardsRequestBuilder	prepareSearchShards(String... indices)
SimulatePipelineRequestBuilder	prepareSimulatePipeline(BytesReference source, XContentType xContentType)
SnapshotsStatusRequestBuilder	prepareSnapshotStatus(TimeValue masterNodeTimeout)
SnapshotsStatusRequestBuilder	prepareSnapshotStatus(TimeValue masterNodeTimeout, String repository)
ClusterStateRequestBuilder	prepareState()
ClusterUpdateSettingsRequestBuilder	prepareUpdateSettings()
VerifyRepositoryRequestBuilder	prepareVerifyRepository(TimeValue masterNodeTimeout, TimeValue ackTimeout, String name)
ActionFuture<AcknowledgedResponse>	putPipeline(PutPipelineRequest request)
void	putPipeline(PutPipelineRequest request, ActionListener<AcknowledgedResponse> listener)
void	putRepository(PutRepositoryRequest request, ActionListener<AcknowledgedResponse> listener)
void	putStoredScript(PutStoredScriptRequest request, ActionListener<AcknowledgedResponse> listener)
ActionFuture<RestoreSnapshotResponse>	restoreSnapshot(RestoreSnapshotRequest request)
void	restoreSnapshot(RestoreSnapshotRequest request, ActionListener<RestoreSnapshotResponse> listener)
void	searchShards(ClusterSearchShardsRequest request, ActionListener<ClusterSearchShardsResponse> listener)
ActionFuture<SimulatePipelineResponse>	simulatePipeline(SimulatePipelineRequest request)
void	simulatePipeline(SimulatePipelineRequest request, ActionListener<SimulatePipelineResponse> listener)
void	snapshotsStatus(SnapshotsStatusRequest request, ActionListener<SnapshotsStatusResponse> listener)
ActionFuture<ClusterStateResponse>	state(ClusterStateRequest request)
void	state(ClusterStateRequest request, ActionListener<ClusterStateResponse> listener)
ThreadPool	threadPool()	Returns the threadpool used to execute requests on this client
ActionFuture<ClusterUpdateSettingsResponse>	updateSettings(ClusterUpdateSettingsRequest request)
void	updateSettings(ClusterUpdateSettingsRequest request, ActionListener<ClusterUpdateSettingsResponse> listener)
void	verifyRepository(VerifyRepositoryRequest request, ActionListener<VerifyRepositoryResponse> listener)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

client

protected final ElasticsearchClient client

Constructor Details

ClusterAdminClient

public ClusterAdminClient(ElasticsearchClient client)

Method Details

execute

public <Request extends ActionRequest,
Response extends ActionResponse>
ActionFuture<Response> execute(ActionType<Response> action,
 Request request)

Description copied from interface: ElasticsearchClient

Executes a generic action, denoted by an ActionType.

Specified by:

execute in interface ElasticsearchClient

Type Parameters:

Request - The request type.

Response - the response type.

Parameters:

action - The action type to execute.

request - The action request.

Returns:

A future allowing to get back the response.

execute

public <Request extends ActionRequest,
Response extends ActionResponse>
void execute(ActionType<Response> action,
 Request request,
 ActionListener<Response> listener)

Description copied from interface: ElasticsearchClient

Executes a generic action, denoted by an ActionType.

Specified by:

execute in interface ElasticsearchClient

Type Parameters:

Request - The request type.

Response - The response type.

Parameters:

action - The action type to execute.

request - The action request.

listener - The listener to receive the response back.

threadPool

public ThreadPool threadPool()

Description copied from interface: ElasticsearchClient

Returns the threadpool used to execute requests on this client

Specified by:

threadPool in interface ElasticsearchClient

health

public ActionFuture<ClusterHealthResponse> health(ClusterHealthRequest request)

health

public void health(ClusterHealthRequest request,
 ActionListener<ClusterHealthResponse> listener)

prepareHealth

public ClusterHealthRequestBuilder prepareHealth(String... indices)

state

public ActionFuture<ClusterStateResponse> state(ClusterStateRequest request)

state

public void state(ClusterStateRequest request,
 ActionListener<ClusterStateResponse> listener)

prepareState

public ClusterStateRequestBuilder prepareState()

updateSettings

public ActionFuture<ClusterUpdateSettingsResponse> updateSettings(ClusterUpdateSettingsRequest request)

updateSettings

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

prepareUpdateSettings

public ClusterUpdateSettingsRequestBuilder prepareUpdateSettings()

nodesInfo

public ActionFuture<NodesInfoResponse> nodesInfo(NodesInfoRequest request)

nodesInfo

public void nodesInfo(NodesInfoRequest request,
 ActionListener<NodesInfoResponse> listener)

prepareNodesInfo

public NodesInfoRequestBuilder prepareNodesInfo(String... nodesIds)

clusterStats

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

prepareClusterStats

public ClusterStatsRequestBuilder prepareClusterStats()

nodesStats

public ActionFuture<NodesStatsResponse> nodesStats(NodesStatsRequest request)

nodesStats

public void nodesStats(NodesStatsRequest request,
 ActionListener<NodesStatsResponse> listener)

prepareNodesStats

public NodesStatsRequestBuilder prepareNodesStats(String... nodesIds)

nodesCapabilities

public ActionFuture<NodesCapabilitiesResponse> nodesCapabilities(NodesCapabilitiesRequest request)

nodesCapabilities

public void nodesCapabilities(NodesCapabilitiesRequest request,
 ActionListener<NodesCapabilitiesResponse> listener)

nodesUsage

public void nodesUsage(NodesUsageRequest request,
 ActionListener<NodesUsageResponse> listener)

listTasks

public ActionFuture<ListTasksResponse> listTasks(ListTasksRequest request)

listTasks

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

prepareListTasks

public ListTasksRequestBuilder prepareListTasks(String... nodesIds)

getTask

public ActionFuture<GetTaskResponse> getTask(GetTaskRequest request)

getTask

public void getTask(GetTaskRequest request,
 ActionListener<GetTaskResponse> listener)

prepareGetTask

public GetTaskRequestBuilder prepareGetTask(String taskId)

prepareGetTask

public GetTaskRequestBuilder prepareGetTask(TaskId taskId)

cancelTasks

public ActionFuture<ListTasksResponse> cancelTasks(CancelTasksRequest request)

cancelTasks

public void cancelTasks(CancelTasksRequest request,
 ActionListener<ListTasksResponse> listener)

prepareCancelTasks

public CancelTasksRequestBuilder prepareCancelTasks(String... nodesIds)

searchShards

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

prepareSearchShards

public ClusterSearchShardsRequestBuilder prepareSearchShards(String... indices)

putRepository

public void putRepository(PutRepositoryRequest request,
 ActionListener<AcknowledgedResponse> listener)

preparePutRepository

public PutRepositoryRequestBuilder preparePutRepository(TimeValue masterNodeTimeout,
 TimeValue ackTimeout,
 String name)

preparePutRepository

@Deprecated(forRemoval=true)
public PutRepositoryRequestBuilder preparePutRepository(String name)

Deprecated, for removal: This API element is subject to removal in a future version.

deleteRepository

public void deleteRepository(DeleteRepositoryRequest request,
 ActionListener<AcknowledgedResponse> listener)

prepareDeleteRepository

public DeleteRepositoryRequestBuilder prepareDeleteRepository(TimeValue masterNodeTimeout,
 TimeValue ackTimeout,
 String name)

prepareDeleteRepository

@Deprecated(forRemoval=true)
public DeleteRepositoryRequestBuilder prepareDeleteRepository(String name)

Deprecated, for removal: This API element is subject to removal in a future version.

getRepositories

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

prepareGetRepositories

public GetRepositoriesRequestBuilder prepareGetRepositories(TimeValue masterNodeTimeout,
 String... name)

prepareCleanupRepository

public CleanupRepositoryRequestBuilder prepareCleanupRepository(TimeValue masterNodeTimeout,
 TimeValue ackTimeout,
 String repository)

cleanupRepository

public void cleanupRepository(CleanupRepositoryRequest request,
 ActionListener<CleanupRepositoryResponse> listener)

verifyRepository

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

prepareVerifyRepository

public VerifyRepositoryRequestBuilder prepareVerifyRepository(TimeValue masterNodeTimeout,
 TimeValue ackTimeout,
 String name)

createSnapshot

public ActionFuture<CreateSnapshotResponse> createSnapshot(CreateSnapshotRequest request)

createSnapshot

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

prepareCreateSnapshot

@Deprecated(forRemoval=true)
public CreateSnapshotRequestBuilder prepareCreateSnapshot(String repository,
 String name)

Deprecated, for removal: This API element is subject to removal in a future version.

prepareCreateSnapshot

public CreateSnapshotRequestBuilder prepareCreateSnapshot(TimeValue masterNodeTimeout,
 String repository,
 String name)

prepareCloneSnapshot

public CloneSnapshotRequestBuilder prepareCloneSnapshot(TimeValue masterNodeTimeout,
 String repository,
 String source,
 String target)

cloneSnapshot

public void cloneSnapshot(CloneSnapshotRequest request,
 ActionListener<AcknowledgedResponse> listener)

getSnapshots

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

prepareGetSnapshots

public GetSnapshotsRequestBuilder prepareGetSnapshots(TimeValue masterNodeTimeout,
 String... repositories)

prepareGetSnapshots

@Deprecated(forRemoval=true)
public GetSnapshotsRequestBuilder prepareGetSnapshots(String... repositories)

Deprecated, for removal: This API element is subject to removal in a future version.

deleteSnapshot

public void deleteSnapshot(DeleteSnapshotRequest request,
 ActionListener<AcknowledgedResponse> listener)

prepareDeleteSnapshot

@Deprecated(forRemoval=true)
public DeleteSnapshotRequestBuilder prepareDeleteSnapshot(String repository,
 String... names)

Deprecated, for removal: This API element is subject to removal in a future version.

prepareDeleteSnapshot

public DeleteSnapshotRequestBuilder prepareDeleteSnapshot(TimeValue masterNodeTimeout,
 String repository,
 String... names)

restoreSnapshot

public ActionFuture<RestoreSnapshotResponse> restoreSnapshot(RestoreSnapshotRequest request)

restoreSnapshot

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

prepareRestoreSnapshot

@Deprecated(forRemoval=true)
public RestoreSnapshotRequestBuilder prepareRestoreSnapshot(String repository,
 String snapshot)

Deprecated, for removal: This API element is subject to removal in a future version.

prepareRestoreSnapshot

public RestoreSnapshotRequestBuilder prepareRestoreSnapshot(TimeValue masterNodeTimeout,
 String repository,
 String snapshot)

snapshotsStatus

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

prepareSnapshotStatus

public SnapshotsStatusRequestBuilder prepareSnapshotStatus(TimeValue masterNodeTimeout,
 String repository)

prepareSnapshotStatus

public SnapshotsStatusRequestBuilder prepareSnapshotStatus(TimeValue masterNodeTimeout)

putPipeline

public void putPipeline(PutPipelineRequest request,
 ActionListener<AcknowledgedResponse> listener)

putPipeline

public ActionFuture<AcknowledgedResponse> putPipeline(PutPipelineRequest request)

preparePutPipeline

public PutPipelineRequestBuilder preparePutPipeline(String id,
 BytesReference source,
 XContentType xContentType)

deletePipeline

public void deletePipeline(DeletePipelineRequest request,
 ActionListener<AcknowledgedResponse> listener)

deletePipeline

public ActionFuture<AcknowledgedResponse> deletePipeline(DeletePipelineRequest request)

prepareDeletePipeline

public DeletePipelineRequestBuilder prepareDeletePipeline(String id)

getPipeline

public void getPipeline(GetPipelineRequest request,
 ActionListener<GetPipelineResponse> listener)

prepareGetPipeline

public GetPipelineRequestBuilder prepareGetPipeline(String... ids)

simulatePipeline

public void simulatePipeline(SimulatePipelineRequest request,
 ActionListener<SimulatePipelineResponse> listener)

simulatePipeline

public ActionFuture<SimulatePipelineResponse> simulatePipeline(SimulatePipelineRequest request)

prepareSimulatePipeline

public SimulatePipelineRequestBuilder prepareSimulatePipeline(BytesReference source,
 XContentType xContentType)

preparePutStoredScript

public PutStoredScriptRequestBuilder preparePutStoredScript()

deleteStoredScript

public void deleteStoredScript(DeleteStoredScriptRequest request,
 ActionListener<AcknowledgedResponse> listener)

prepareDeleteStoredScript

public DeleteStoredScriptRequestBuilder prepareDeleteStoredScript(String id)

putStoredScript

public void putStoredScript(PutStoredScriptRequest request,
 ActionListener<AcknowledgedResponse> listener)

prepareGetStoredScript

public GetStoredScriptRequestBuilder prepareGetStoredScript(String id)

getStoredScript

public void getStoredScript(GetStoredScriptRequest request,
 ActionListener<GetStoredScriptResponse> listener)