org.elasticsearch.client.ClusterAdminClient Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of elasticsearch Show documentation
Show all versions of elasticsearch Show documentation
Elasticsearch subproject :server
/*
* Licensed to Elasticsearch under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.elasticsearch.client;
import org.elasticsearch.action.ActionFuture;
import org.elasticsearch.action.ActionListener;
import org.elasticsearch.action.admin.cluster.allocation.ClusterAllocationExplainRequest;
import org.elasticsearch.action.admin.cluster.allocation.ClusterAllocationExplainRequestBuilder;
import org.elasticsearch.action.admin.cluster.allocation.ClusterAllocationExplainResponse;
import org.elasticsearch.action.admin.cluster.health.ClusterHealthRequest;
import org.elasticsearch.action.admin.cluster.health.ClusterHealthRequestBuilder;
import org.elasticsearch.action.admin.cluster.health.ClusterHealthResponse;
import org.elasticsearch.action.admin.cluster.node.hotthreads.NodesHotThreadsRequest;
import org.elasticsearch.action.admin.cluster.node.hotthreads.NodesHotThreadsRequestBuilder;
import org.elasticsearch.action.admin.cluster.node.hotthreads.NodesHotThreadsResponse;
import org.elasticsearch.action.admin.cluster.node.info.NodesInfoRequest;
import org.elasticsearch.action.admin.cluster.node.info.NodesInfoRequestBuilder;
import org.elasticsearch.action.admin.cluster.node.info.NodesInfoResponse;
import org.elasticsearch.action.admin.cluster.node.reload.NodesReloadSecureSettingsRequestBuilder;
import org.elasticsearch.action.admin.cluster.node.stats.NodesStatsRequest;
import org.elasticsearch.action.admin.cluster.node.stats.NodesStatsRequestBuilder;
import org.elasticsearch.action.admin.cluster.node.stats.NodesStatsResponse;
import org.elasticsearch.action.admin.cluster.node.tasks.cancel.CancelTasksRequest;
import org.elasticsearch.action.admin.cluster.node.tasks.cancel.CancelTasksRequestBuilder;
import org.elasticsearch.action.admin.cluster.node.tasks.cancel.CancelTasksResponse;
import org.elasticsearch.action.admin.cluster.node.tasks.get.GetTaskRequest;
import org.elasticsearch.action.admin.cluster.node.tasks.get.GetTaskRequestBuilder;
import org.elasticsearch.action.admin.cluster.node.tasks.get.GetTaskResponse;
import org.elasticsearch.action.admin.cluster.node.tasks.list.ListTasksRequest;
import org.elasticsearch.action.admin.cluster.node.tasks.list.ListTasksRequestBuilder;
import org.elasticsearch.action.admin.cluster.node.tasks.list.ListTasksResponse;
import org.elasticsearch.action.admin.cluster.node.usage.NodesUsageRequest;
import org.elasticsearch.action.admin.cluster.node.usage.NodesUsageRequestBuilder;
import org.elasticsearch.action.admin.cluster.node.usage.NodesUsageResponse;
import org.elasticsearch.action.admin.cluster.repositories.cleanup.CleanupRepositoryRequest;
import org.elasticsearch.action.admin.cluster.repositories.cleanup.CleanupRepositoryRequestBuilder;
import org.elasticsearch.action.admin.cluster.repositories.cleanup.CleanupRepositoryResponse;
import org.elasticsearch.action.admin.cluster.repositories.delete.DeleteRepositoryRequest;
import org.elasticsearch.action.admin.cluster.repositories.delete.DeleteRepositoryRequestBuilder;
import org.elasticsearch.action.admin.cluster.repositories.get.GetRepositoriesRequest;
import org.elasticsearch.action.admin.cluster.repositories.get.GetRepositoriesRequestBuilder;
import org.elasticsearch.action.admin.cluster.repositories.get.GetRepositoriesResponse;
import org.elasticsearch.action.admin.cluster.repositories.put.PutRepositoryRequest;
import org.elasticsearch.action.admin.cluster.repositories.put.PutRepositoryRequestBuilder;
import org.elasticsearch.action.admin.cluster.repositories.verify.VerifyRepositoryRequest;
import org.elasticsearch.action.admin.cluster.repositories.verify.VerifyRepositoryRequestBuilder;
import org.elasticsearch.action.admin.cluster.repositories.verify.VerifyRepositoryResponse;
import org.elasticsearch.action.admin.cluster.reroute.ClusterRerouteRequest;
import org.elasticsearch.action.admin.cluster.reroute.ClusterRerouteRequestBuilder;
import org.elasticsearch.action.admin.cluster.reroute.ClusterRerouteResponse;
import org.elasticsearch.action.admin.cluster.settings.ClusterUpdateSettingsRequest;
import org.elasticsearch.action.admin.cluster.settings.ClusterUpdateSettingsRequestBuilder;
import org.elasticsearch.action.admin.cluster.settings.ClusterUpdateSettingsResponse;
import org.elasticsearch.action.admin.cluster.shards.ClusterSearchShardsRequest;
import org.elasticsearch.action.admin.cluster.shards.ClusterSearchShardsRequestBuilder;
import org.elasticsearch.action.admin.cluster.shards.ClusterSearchShardsResponse;
import org.elasticsearch.action.admin.cluster.snapshots.create.CreateSnapshotRequest;
import org.elasticsearch.action.admin.cluster.snapshots.create.CreateSnapshotRequestBuilder;
import org.elasticsearch.action.admin.cluster.snapshots.create.CreateSnapshotResponse;
import org.elasticsearch.action.admin.cluster.snapshots.delete.DeleteSnapshotRequest;
import org.elasticsearch.action.admin.cluster.snapshots.delete.DeleteSnapshotRequestBuilder;
import org.elasticsearch.action.admin.cluster.snapshots.get.GetSnapshotsRequest;
import org.elasticsearch.action.admin.cluster.snapshots.get.GetSnapshotsRequestBuilder;
import org.elasticsearch.action.admin.cluster.snapshots.get.GetSnapshotsResponse;
import org.elasticsearch.action.admin.cluster.snapshots.restore.RestoreSnapshotRequest;
import org.elasticsearch.action.admin.cluster.snapshots.restore.RestoreSnapshotRequestBuilder;
import org.elasticsearch.action.admin.cluster.snapshots.restore.RestoreSnapshotResponse;
import org.elasticsearch.action.admin.cluster.snapshots.status.SnapshotsStatusRequest;
import org.elasticsearch.action.admin.cluster.snapshots.status.SnapshotsStatusRequestBuilder;
import org.elasticsearch.action.admin.cluster.snapshots.status.SnapshotsStatusResponse;
import org.elasticsearch.action.admin.cluster.state.ClusterStateRequest;
import org.elasticsearch.action.admin.cluster.state.ClusterStateRequestBuilder;
import org.elasticsearch.action.admin.cluster.state.ClusterStateResponse;
import org.elasticsearch.action.admin.cluster.stats.ClusterStatsRequest;
import org.elasticsearch.action.admin.cluster.stats.ClusterStatsRequestBuilder;
import org.elasticsearch.action.admin.cluster.stats.ClusterStatsResponse;
import org.elasticsearch.action.admin.cluster.storedscripts.DeleteStoredScriptRequest;
import org.elasticsearch.action.admin.cluster.storedscripts.DeleteStoredScriptRequestBuilder;
import org.elasticsearch.action.admin.cluster.storedscripts.GetStoredScriptRequest;
import org.elasticsearch.action.admin.cluster.storedscripts.GetStoredScriptRequestBuilder;
import org.elasticsearch.action.admin.cluster.storedscripts.GetStoredScriptResponse;
import org.elasticsearch.action.admin.cluster.storedscripts.PutStoredScriptRequest;
import org.elasticsearch.action.admin.cluster.storedscripts.PutStoredScriptRequestBuilder;
import org.elasticsearch.action.admin.cluster.tasks.PendingClusterTasksRequest;
import org.elasticsearch.action.admin.cluster.tasks.PendingClusterTasksRequestBuilder;
import org.elasticsearch.action.admin.cluster.tasks.PendingClusterTasksResponse;
import org.elasticsearch.action.ingest.DeletePipelineRequest;
import org.elasticsearch.action.ingest.DeletePipelineRequestBuilder;
import org.elasticsearch.action.ingest.GetPipelineRequest;
import org.elasticsearch.action.ingest.GetPipelineRequestBuilder;
import org.elasticsearch.action.ingest.GetPipelineResponse;
import org.elasticsearch.action.ingest.PutPipelineRequest;
import org.elasticsearch.action.ingest.PutPipelineRequestBuilder;
import org.elasticsearch.action.ingest.SimulatePipelineRequest;
import org.elasticsearch.action.ingest.SimulatePipelineRequestBuilder;
import org.elasticsearch.action.ingest.SimulatePipelineResponse;
import org.elasticsearch.action.support.master.AcknowledgedResponse;
import org.elasticsearch.common.bytes.BytesReference;
import org.elasticsearch.common.xcontent.XContentType;
import org.elasticsearch.tasks.TaskId;
/**
* Administrative actions/operations against indices.
*
* @see AdminClient#cluster()
*/
public interface ClusterAdminClient extends ElasticsearchClient {
/**
* The health of the cluster.
*
* @param request The cluster state request
* @return The result future
* @see Requests#clusterHealthRequest(String...)
*/
ActionFuture health(ClusterHealthRequest request);
/**
* The health of the cluster.
*
* @param request The cluster state request
* @param listener A listener to be notified with a result
* @see Requests#clusterHealthRequest(String...)
*/
void health(ClusterHealthRequest request, ActionListener listener);
/**
* The health of the cluster.
*/
ClusterHealthRequestBuilder prepareHealth(String... indices);
/**
* The state of the cluster.
*
* @param request The cluster state request.
* @return The result future
* @see Requests#clusterStateRequest()
*/
ActionFuture state(ClusterStateRequest request);
/**
* The state of the cluster.
*
* @param request The cluster state request.
* @param listener A listener to be notified with a result
* @see Requests#clusterStateRequest()
*/
void state(ClusterStateRequest request, ActionListener listener);
/**
* The state of the cluster.
*/
ClusterStateRequestBuilder prepareState();
/**
* Updates settings in the cluster.
*/
ActionFuture updateSettings(ClusterUpdateSettingsRequest request);
/**
* Update settings in the cluster.
*/
void updateSettings(ClusterUpdateSettingsRequest request, ActionListener listener);
/**
* Update settings in the cluster.
*/
ClusterUpdateSettingsRequestBuilder prepareUpdateSettings();
/**
* Re initialize each cluster node and pass them the secret store password.
*/
NodesReloadSecureSettingsRequestBuilder prepareReloadSecureSettings();
/**
* Reroutes allocation of shards. Advance API.
*/
ActionFuture reroute(ClusterRerouteRequest request);
/**
* Reroutes allocation of shards. Advance API.
*/
void reroute(ClusterRerouteRequest request, ActionListener listener);
/**
* Update settings in the cluster.
*/
ClusterRerouteRequestBuilder prepareReroute();
/**
* Nodes info of the cluster.
*
* @param request The nodes info request
* @return The result future
* @see org.elasticsearch.client.Requests#nodesInfoRequest(String...)
*/
ActionFuture nodesInfo(NodesInfoRequest request);
/**
* Nodes info of the cluster.
*
* @param request The nodes info request
* @param listener A listener to be notified with a result
* @see org.elasticsearch.client.Requests#nodesInfoRequest(String...)
*/
void nodesInfo(NodesInfoRequest request, ActionListener listener);
/**
* Nodes info of the cluster.
*/
NodesInfoRequestBuilder prepareNodesInfo(String... nodesIds);
/**
* Cluster wide aggregated stats.
*
* @param request The cluster stats request
* @return The result future
* @see org.elasticsearch.client.Requests#clusterStatsRequest
*/
ActionFuture clusterStats(ClusterStatsRequest request);
/**
* Cluster wide aggregated stats
*
* @param request The cluster stats request
* @param listener A listener to be notified with a result
* @see org.elasticsearch.client.Requests#clusterStatsRequest()
*/
void clusterStats(ClusterStatsRequest request, ActionListener listener);
ClusterStatsRequestBuilder prepareClusterStats();
/**
* Nodes stats of the cluster.
*
* @param request The nodes stats request
* @return The result future
* @see org.elasticsearch.client.Requests#nodesStatsRequest(String...)
*/
ActionFuture nodesStats(NodesStatsRequest request);
/**
* Nodes stats of the cluster.
*
* @param request The nodes info request
* @param listener A listener to be notified with a result
* @see org.elasticsearch.client.Requests#nodesStatsRequest(String...)
*/
void nodesStats(NodesStatsRequest request, ActionListener listener);
/**
* Nodes stats of the cluster.
*/
NodesStatsRequestBuilder prepareNodesStats(String... nodesIds);
/**
* 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.
*
* @param request
* The nodes usage request
* @return The result future
* @see org.elasticsearch.client.Requests#nodesUsageRequest(String...)
*/
ActionFuture nodesUsage(NodesUsageRequest request);
/**
* Nodes usage of the cluster.
*
* @param request
* The nodes usage request
* @param listener
* A listener to be notified with a result
* @see org.elasticsearch.client.Requests#nodesUsageRequest(String...)
*/
void nodesUsage(NodesUsageRequest request, ActionListener listener);
/**
* Nodes usage of the cluster.
*/
NodesUsageRequestBuilder prepareNodesUsage(String... nodesIds);
/**
* Returns top N hot-threads samples per node. The hot-threads are only
* sampled for the node ids specified in the request.
*
*/
ActionFuture 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.
*/
void nodesHotThreads(NodesHotThreadsRequest request, ActionListener listener);
/**
* 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 {@code *} to fetch samples for all nodes
*/
NodesHotThreadsRequestBuilder prepareNodesHotThreads(String... nodesIds);
/**
* List tasks
*
* @param request The nodes tasks request
* @return The result future
* @see org.elasticsearch.client.Requests#listTasksRequest()
*/
ActionFuture listTasks(ListTasksRequest request);
/**
* List active tasks
*
* @param request The nodes tasks request
* @param listener A listener to be notified with a result
* @see org.elasticsearch.client.Requests#listTasksRequest()
*/
void listTasks(ListTasksRequest request, ActionListener listener);
/**
* List active tasks
*/
ListTasksRequestBuilder prepareListTasks(String... nodesIds);
/**
* Get a task.
*
* @param request the request
* @return the result future
* @see org.elasticsearch.client.Requests#getTaskRequest()
*/
ActionFuture getTask(GetTaskRequest request);
/**
* Get a task.
*
* @param request the request
* @param listener A listener to be notified with the result
* @see org.elasticsearch.client.Requests#getTaskRequest()
*/
void getTask(GetTaskRequest request, ActionListener listener);
/**
* Fetch a task by id.
*/
GetTaskRequestBuilder prepareGetTask(String taskId);
/**
* Fetch a task by id.
*/
GetTaskRequestBuilder prepareGetTask(TaskId taskId);
/**
* Cancel tasks
*
* @param request The nodes tasks request
* @return The result future
* @see org.elasticsearch.client.Requests#cancelTasksRequest()
*/
ActionFuture cancelTasks(CancelTasksRequest request);
/**
* Cancel active tasks
*
* @param request The nodes tasks request
* @param listener A listener to be notified with a result
* @see org.elasticsearch.client.Requests#cancelTasksRequest()
*/
void cancelTasks(CancelTasksRequest request, ActionListener listener);
/**
* Cancel active tasks
*/
CancelTasksRequestBuilder prepareCancelTasks(String... nodesIds);
/**
* Returns list of shards the given search would be executed on.
*/
ActionFuture searchShards(ClusterSearchShardsRequest request);
/**
* Returns list of shards the given search would be executed on.
*/
void searchShards(ClusterSearchShardsRequest request, ActionListener listener);
/**
* Returns list of shards the given search would be executed on.
*/
ClusterSearchShardsRequestBuilder prepareSearchShards();
/**
* Returns list of shards the given search would be executed on.
*/
ClusterSearchShardsRequestBuilder prepareSearchShards(String... indices);
/**
* Registers a snapshot repository.
*/
ActionFuture putRepository(PutRepositoryRequest request);
/**
* Registers a snapshot repository.
*/
void putRepository(PutRepositoryRequest request, ActionListener listener);
/**
* Registers a snapshot repository.
*/
PutRepositoryRequestBuilder preparePutRepository(String name);
/**
* Unregisters a repository.
*/
ActionFuture deleteRepository(DeleteRepositoryRequest request);
/**
* Unregisters a repository.
*/
void deleteRepository(DeleteRepositoryRequest request, ActionListener listener);
/**
* Unregisters a repository.
*/
DeleteRepositoryRequestBuilder prepareDeleteRepository(String name);
/**
* Gets repositories.
*/
ActionFuture getRepositories(GetRepositoriesRequest request);
/**
* Gets repositories.
*/
void getRepositories(GetRepositoriesRequest request, ActionListener listener);
/**
* Gets repositories.
*/
GetRepositoriesRequestBuilder prepareGetRepositories(String... name);
/**
* Cleans up repository.
*/
CleanupRepositoryRequestBuilder prepareCleanupRepository(String repository);
/**
* Cleans up repository.
*/
ActionFuture cleanupRepository(CleanupRepositoryRequest repository);
/**
* Cleans up repository.
*/
void cleanupRepository(CleanupRepositoryRequest repository, ActionListener listener);
/**
* Verifies a repository.
*/
ActionFuture verifyRepository(VerifyRepositoryRequest request);
/**
* Verifies a repository.
*/
void verifyRepository(VerifyRepositoryRequest request, ActionListener listener);
/**
* Verifies a repository.
*/
VerifyRepositoryRequestBuilder prepareVerifyRepository(String name);
/**
* Creates a new snapshot.
*/
ActionFuture createSnapshot(CreateSnapshotRequest request);
/**
* Creates a new snapshot.
*/
void createSnapshot(CreateSnapshotRequest request, ActionListener listener);
/**
* Creates a new snapshot.
*/
CreateSnapshotRequestBuilder prepareCreateSnapshot(String repository, String name);
/**
* Get snapshot.
*/
ActionFuture getSnapshots(GetSnapshotsRequest request);
/**
* Get snapshot.
*/
void getSnapshots(GetSnapshotsRequest request, ActionListener listener);
/**
* Get snapshot.
*/
GetSnapshotsRequestBuilder prepareGetSnapshots(String repository);
/**
* Delete snapshot.
*/
ActionFuture deleteSnapshot(DeleteSnapshotRequest request);
/**
* Delete snapshot.
*/
void deleteSnapshot(DeleteSnapshotRequest request, ActionListener listener);
/**
* Delete snapshot.
*/
DeleteSnapshotRequestBuilder prepareDeleteSnapshot(String repository, String snapshot);
/**
* Restores a snapshot.
*/
ActionFuture restoreSnapshot(RestoreSnapshotRequest request);
/**
* Restores a snapshot.
*/
void restoreSnapshot(RestoreSnapshotRequest request, ActionListener listener);
/**
* Restores a snapshot.
*/
RestoreSnapshotRequestBuilder prepareRestoreSnapshot(String repository, String snapshot);
/**
* 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)
*/
void pendingClusterTasks(PendingClusterTasksRequest request, ActionListener 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)
*/
ActionFuture 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)
*/
PendingClusterTasksRequestBuilder preparePendingClusterTasks();
/**
* Get snapshot status.
*/
ActionFuture snapshotsStatus(SnapshotsStatusRequest request);
/**
* Get snapshot status.
*/
void snapshotsStatus(SnapshotsStatusRequest request, ActionListener listener);
/**
* Get snapshot status.
*/
SnapshotsStatusRequestBuilder prepareSnapshotStatus(String repository);
/**
* Get snapshot status.
*/
SnapshotsStatusRequestBuilder prepareSnapshotStatus();
/**
* Stores an ingest pipeline
*/
void putPipeline(PutPipelineRequest request, ActionListener listener);
/**
* Stores an ingest pipeline
*/
ActionFuture putPipeline(PutPipelineRequest request);
/**
* Stores an ingest pipeline
*/
PutPipelineRequestBuilder preparePutPipeline(String id, BytesReference source, XContentType xContentType);
/**
* Deletes a stored ingest pipeline
*/
void deletePipeline(DeletePipelineRequest request, ActionListener listener);
/**
* Deletes a stored ingest pipeline
*/
ActionFuture deletePipeline(DeletePipelineRequest request);
/**
* Deletes a stored ingest pipeline
*/
DeletePipelineRequestBuilder prepareDeletePipeline();
/**
* Deletes a stored ingest pipeline
*/
DeletePipelineRequestBuilder prepareDeletePipeline(String id);
/**
* Returns a stored ingest pipeline
*/
void getPipeline(GetPipelineRequest request, ActionListener listener);
/**
* Returns a stored ingest pipeline
*/
ActionFuture getPipeline(GetPipelineRequest request);
/**
* Returns a stored ingest pipeline
*/
GetPipelineRequestBuilder prepareGetPipeline(String... ids);
/**
* Simulates an ingest pipeline
*/
void simulatePipeline(SimulatePipelineRequest request, ActionListener listener);
/**
* Simulates an ingest pipeline
*/
ActionFuture simulatePipeline(SimulatePipelineRequest request);
/**
* Simulates an ingest pipeline
*/
SimulatePipelineRequestBuilder prepareSimulatePipeline(BytesReference source, XContentType xContentType);
/**
* Explain the allocation of a shard
*/
void allocationExplain(ClusterAllocationExplainRequest request, ActionListener listener);
/**
* Explain the allocation of a shard
*/
ActionFuture allocationExplain(ClusterAllocationExplainRequest request);
/**
* Explain the allocation of a shard
*/
ClusterAllocationExplainRequestBuilder prepareAllocationExplain();
/**
* Store a script in the cluster state
*/
PutStoredScriptRequestBuilder preparePutStoredScript();
/**
* Delete a script from the cluster state
*/
void deleteStoredScript(DeleteStoredScriptRequest request, ActionListener listener);
/**
* Delete a script from the cluster state
*/
ActionFuture deleteStoredScript(DeleteStoredScriptRequest request);
/**
* Delete a script from the cluster state
*/
DeleteStoredScriptRequestBuilder prepareDeleteStoredScript();
/**
* Delete a script from the cluster state
*/
DeleteStoredScriptRequestBuilder prepareDeleteStoredScript(String id);
/**
* Store a script in the cluster state
*/
void putStoredScript(PutStoredScriptRequest request, ActionListener listener);
/**
* Store a script in the cluster state
*/
ActionFuture putStoredScript(PutStoredScriptRequest request);
/**
* Get a script from the cluster state
*/
GetStoredScriptRequestBuilder prepareGetStoredScript();
/**
* Get a script from the cluster state
*/
GetStoredScriptRequestBuilder prepareGetStoredScript(String id);
/**
* Get a script from the cluster state
*/
void getStoredScript(GetStoredScriptRequest request, ActionListener listener);
/**
* Get a script from the cluster state
*/
ActionFuture getStoredScript(GetStoredScriptRequest request);
}