Deprecate Index Status API

Elasticsearch 1.1 introduced the recovery API, which replaces the functionality of the index status API. This marks the index status API as deprecated in order to remove it in the future. Relates #4854
elastic · May 7, 2014 · f0d73a8 · f0d73a8
1 parent 4c45e3c
commit f0d73a8
Show file tree

Hide file tree

Showing 14 changed files with 44 additions and 15 deletions.
diff --git a/src/main/java/org/elasticsearch/action/admin/indices/status/DocsStatus.java b/src/main/java/org/elasticsearch/action/admin/indices/status/DocsStatus.java
@@ -20,8 +20,10 @@
 package org.elasticsearch.action.admin.indices.status;
 
 /**
- *
+ * This class will be removed in future versions
+ * Use the recovery API instead
  */
+@Deprecated
 public class DocsStatus {
 
     long numDocs = 0;

diff --git a/src/main/java/org/elasticsearch/action/admin/indices/status/GatewayRecoveryStatus.java b/src/main/java/org/elasticsearch/action/admin/indices/status/GatewayRecoveryStatus.java
@@ -24,8 +24,10 @@
 import org.elasticsearch.common.unit.TimeValue;
 
 /**
- *
+ * This class will be removed in future versions
+ * Use the recovery API instead
  */
+@Deprecated
 public class GatewayRecoveryStatus {
 
     public enum Stage {

diff --git a/src/main/java/org/elasticsearch/action/admin/indices/status/GatewaySnapshotStatus.java b/src/main/java/org/elasticsearch/action/admin/indices/status/GatewaySnapshotStatus.java
@@ -24,8 +24,10 @@
 import org.elasticsearch.common.unit.TimeValue;
 
 /**
- *
+ * This class will be removed in future versions
+ * Use the recovery API instead
  */
+@Deprecated
 public class GatewaySnapshotStatus {
 
     public static enum Stage {

diff --git a/src/main/java/org/elasticsearch/action/admin/indices/status/IndexShardStatus.java b/src/main/java/org/elasticsearch/action/admin/indices/status/IndexShardStatus.java
@@ -29,8 +29,10 @@
 import java.util.Iterator;
 
 /**
- *
+ * This class will be removed in future versions
+ * Use the recovery API instead
  */
+@Deprecated
 public class IndexShardStatus implements Iterable<ShardStatus> {
 
     private final ShardId shardId;

diff --git a/src/main/java/org/elasticsearch/action/admin/indices/status/IndexStatus.java b/src/main/java/org/elasticsearch/action/admin/indices/status/IndexStatus.java
@@ -32,8 +32,10 @@
 import static com.google.common.collect.Lists.newArrayList;
 
 /**
- *
+ * This class will be removed in future versions
+ * Use the recovery API instead
  */
+@Deprecated
 public class IndexStatus implements Iterable<IndexShardStatus> {
 
     private final String index;

diff --git a/src/main/java/org/elasticsearch/action/admin/indices/status/IndicesStatusAction.java b/src/main/java/org/elasticsearch/action/admin/indices/status/IndicesStatusAction.java
@@ -23,7 +23,10 @@
 import org.elasticsearch.client.IndicesAdminClient;
 
 /**
+ * This class will be removed in future versions
+ * Use the recovery API instead
  */
+@Deprecated
 public class IndicesStatusAction extends IndicesAction<IndicesStatusRequest, IndicesStatusResponse, IndicesStatusRequestBuilder> {
 
     public static final IndicesStatusAction INSTANCE = new IndicesStatusAction();

diff --git a/src/main/java/org/elasticsearch/action/admin/indices/status/IndicesStatusRequest.java b/src/main/java/org/elasticsearch/action/admin/indices/status/IndicesStatusRequest.java
@@ -27,8 +27,10 @@
 import java.io.IOException;
 
 /**
- *
+ * This class will be removed in future versions
+ * Use the recovery API instead
  */
+@Deprecated
 public class IndicesStatusRequest extends BroadcastOperationRequest<IndicesStatusRequest> {
 
     private boolean recovery = false;

diff --git a/src/main/java/org/elasticsearch/action/admin/indices/status/IndicesStatusRequestBuilder.java b/src/main/java/org/elasticsearch/action/admin/indices/status/IndicesStatusRequestBuilder.java
@@ -25,8 +25,10 @@
 import org.elasticsearch.client.internal.InternalIndicesAdminClient;
 
 /**
- *
+ * This class will be removed in future versions
+ * Use the recovery API instead
  */
+@Deprecated
 public class IndicesStatusRequestBuilder extends BroadcastOperationRequestBuilder<IndicesStatusRequest, IndicesStatusResponse, IndicesStatusRequestBuilder> {
 
     public IndicesStatusRequestBuilder(IndicesAdminClient indicesClient) {

diff --git a/src/main/java/org/elasticsearch/action/admin/indices/status/IndicesStatusResponse.java b/src/main/java/org/elasticsearch/action/admin/indices/status/IndicesStatusResponse.java
@@ -44,8 +44,10 @@
 import static org.elasticsearch.action.admin.indices.status.ShardStatus.readIndexShardStatus;
 
 /**
- *
+ * This class will be removed in future versions
+ * Use the recovery API instead
  */
+@Deprecated
 public class IndicesStatusResponse extends BroadcastOperationResponse implements ToXContent {
 
     protected ShardStatus[] shards;

diff --git a/src/main/java/org/elasticsearch/action/admin/indices/status/PeerRecoveryStatus.java b/src/main/java/org/elasticsearch/action/admin/indices/status/PeerRecoveryStatus.java
@@ -24,8 +24,10 @@
 import org.elasticsearch.common.unit.TimeValue;
 
 /**
- *
+ * This class will be removed in future versions
+ * Use the recovery API instead
  */
+@Deprecated
 public class PeerRecoveryStatus {
 
     public enum Stage {

diff --git a/src/main/java/org/elasticsearch/action/admin/indices/status/ShardStatus.java b/src/main/java/org/elasticsearch/action/admin/indices/status/ShardStatus.java
@@ -35,8 +35,10 @@
 import static org.elasticsearch.common.unit.ByteSizeValue.readBytesSizeValue;
 
 /**
- * Shard instance (actual allocated shard) status.
+ * This class will be removed in future versions
+ * Use the recovery API instead
  */
+@Deprecated
 public class ShardStatus extends BroadcastShardOperationResponse {
 
     private ShardRouting shardRouting;

diff --git a/...main/java/org/elasticsearch/action/admin/indices/status/TransportIndicesStatusAction.java b/...main/java/org/elasticsearch/action/admin/indices/status/TransportIndicesStatusAction.java
@@ -54,8 +54,10 @@
 import static com.google.common.collect.Lists.newArrayList;
 
 /**
- *
+ * This class will be removed in future versions
+ * Use the recovery API instead
  */
+@Deprecated
 public class TransportIndicesStatusAction extends TransportBroadcastOperationAction<IndicesStatusRequest, IndicesStatusResponse, TransportIndicesStatusAction.IndexShardStatusRequest, ShardStatus> {
 
     private final IndicesService indicesService;

diff --git a/src/main/java/org/elasticsearch/client/IndicesAdminClient.java b/src/main/java/org/elasticsearch/client/IndicesAdminClient.java
@@ -200,26 +200,29 @@ public interface IndicesAdminClient {
     RecoveryRequestBuilder prepareRecoveries(String... indices);
 
     /**
-     * The status of one or more indices.
+     * The status of one or more indices. Use the recovery API instead
      *
      * @param request The indices status request
      * @return The result future
      * @see Requests#indicesStatusRequest(String...)
      */
+    @Deprecated
     ActionFuture<IndicesStatusResponse> status(IndicesStatusRequest request);
 
     /**
-     * The status of one or more indices.
+     * The status of one or more indices. Use the recovery API instead.
      *
      * @param request  The indices status request
      * @param listener A listener to be notified with a result
      * @see Requests#indicesStatusRequest(String...)
      */
+    @Deprecated
     void status(IndicesStatusRequest request, ActionListener<IndicesStatusResponse> listener);
 
     /**
-     * The status of one or more indices.
+     * The status of one or more indices. Use the recovery API instead
      */
+    @Deprecated
     IndicesStatusRequestBuilder prepareStatus(String... indices);
 
     /**

diff --git a/src/main/java/org/elasticsearch/client/Requests.java b/src/main/java/org/elasticsearch/client/Requests.java
@@ -185,12 +185,13 @@ public static SearchScrollRequest searchScrollRequest(String scrollId) {
     }
 
     /**
-     * Creates an indices status request.
+     * Creates an indices status request. Use the Recovery API instead
      *
      * @param indices The indices to query status about. Use <tt>null</tt> or <tt>_all</tt> to execute against all indices
      * @return The indices status request
      * @see org.elasticsearch.client.IndicesAdminClient#status(org.elasticsearch.action.admin.indices.status.IndicesStatusRequest)
      */
+    @Deprecated
     public static IndicesStatusRequest indicesStatusRequest(String... indices) {
         return new IndicesStatusRequest(indices);
     }