[java] Deprecate async replication in java API

Follow up for PR #10171. As we discussed #10114 (comment), we should also mark the code as deprecated so plugin developers know in advance that they need to adapt their code.
elastic · May 29, 2015 · f2ed5d1 · f2ed5d1
1 parent eae3ddd
commit f2ed5d1
Show file tree

Hide file tree

Showing 8 changed files with 31 additions and 0 deletions.
diff --git a/src/main/java/org/elasticsearch/action/bulk/BulkRequest.java b/src/main/java/org/elasticsearch/action/bulk/BulkRequest.java
@@ -424,12 +424,19 @@ public boolean refresh() {
 
     /**
      * Set the replication type for this operation.
+     * @deprecated will be removed in 2.0.0. See https://github.com/elastic/elasticsearch/pull/10171
      */
+    @Deprecated
     public BulkRequest replicationType(ReplicationType replicationType) {
         this.replicationType = replicationType;
         return this;
     }
 
+    /**
+     * Get the replication type for this operation.
+     * @deprecated will be removed in 2.0.0. See https://github.com/elastic/elasticsearch/pull/10171
+     */
+    @Deprecated
     public ReplicationType replicationType() {
         return this.replicationType;
     }

diff --git a/src/main/java/org/elasticsearch/action/bulk/BulkRequestBuilder.java b/src/main/java/org/elasticsearch/action/bulk/BulkRequestBuilder.java
@@ -112,7 +112,9 @@ public BulkRequestBuilder add(byte[] data, int from, int length, @Nullable Strin
 
     /**
      * Set the replication type for this operation.
+     * @deprecated will be removed in 2.0.0. See https://github.com/elastic/elasticsearch/pull/10171
      */
+    @Deprecated
     public BulkRequestBuilder setReplicationType(ReplicationType replicationType) {
         request.replicationType(replicationType);
         return this;

diff --git a/...g/elasticsearch/action/support/replication/IndicesReplicationOperationRequestBuilder.java b/...g/elasticsearch/action/support/replication/IndicesReplicationOperationRequestBuilder.java
@@ -71,7 +71,9 @@ public RequestBuilder setIndicesOptions(IndicesOptions indicesOptions) {
 
     /**
      * Sets the replication type.
+     * @deprecated will be removed in 2.0.0. See https://github.com/elastic/elasticsearch/pull/10171
      */
+    @Deprecated
     @SuppressWarnings("unchecked")
     public RequestBuilder setReplicationType(ReplicationType replicationType) {
         request.replicationType(replicationType);
@@ -80,7 +82,9 @@ public RequestBuilder setReplicationType(ReplicationType replicationType) {
 
     /**
      * Sets the replication type.
+     * @deprecated will be removed in 2.0.0. See https://github.com/elastic/elasticsearch/pull/10171
      */
+    @Deprecated
     @SuppressWarnings("unchecked")
     public RequestBuilder setReplicationType(String replicationType) {
         request.replicationType(replicationType);

diff --git a/src/main/java/org/elasticsearch/action/support/replication/ReplicationType.java b/src/main/java/org/elasticsearch/action/support/replication/ReplicationType.java
@@ -23,7 +23,9 @@
 
 /**
  * The type of replication to perform.
+ * @deprecated will be removed in 2.0.0. See https://github.com/elastic/elasticsearch/pull/10171
  */
+@Deprecated
 public enum ReplicationType {
     /**
      * Sync replication, wait till all replicas have performed the operation.

diff --git a/...n/java/org/elasticsearch/action/support/replication/ShardReplicationOperationRequest.java b/...n/java/org/elasticsearch/action/support/replication/ShardReplicationOperationRequest.java
@@ -151,14 +151,18 @@ public IndicesOptions indicesOptions() {
 
     /**
      * The replication type.
+     * @deprecated will be removed in 2.0.0. See https://github.com/elastic/elasticsearch/pull/10171
      */
+    @Deprecated
     public ReplicationType replicationType() {
         return this.replicationType;
     }
 
     /**
      * Sets the replication type.
+     * @deprecated will be removed in 2.0.0. See https://github.com/elastic/elasticsearch/pull/10171
      */
+    @Deprecated
     @SuppressWarnings("unchecked")
     public final T replicationType(ReplicationType replicationType) {
         this.replicationType = replicationType;
@@ -167,7 +171,9 @@ public final T replicationType(ReplicationType replicationType) {
 
     /**
      * Sets the replication type.
+     * @deprecated will be removed in 2.0.0. See https://github.com/elastic/elasticsearch/pull/10171
      */
+    @Deprecated
     public final T replicationType(String replicationType) {
         return replicationType(ReplicationType.fromString(replicationType));
     }

diff --git a/...org/elasticsearch/action/support/replication/ShardReplicationOperationRequestBuilder.java b/...org/elasticsearch/action/support/replication/ShardReplicationOperationRequestBuilder.java
@@ -70,7 +70,9 @@ public final RequestBuilder setIndex(String index) {
 
     /**
      * Sets the replication type.
+     * @deprecated will be removed in 2.0.0. See https://github.com/elastic/elasticsearch/pull/10171
      */
+    @Deprecated
     @SuppressWarnings("unchecked")
     public RequestBuilder setReplicationType(ReplicationType replicationType) {
         request.replicationType(replicationType);
@@ -79,7 +81,9 @@ public RequestBuilder setReplicationType(ReplicationType replicationType) {
 
     /**
      * Sets the replication type.
+     * @deprecated will be removed in 2.0.0. See https://github.com/elastic/elasticsearch/pull/10171
      */
+    @Deprecated
     @SuppressWarnings("unchecked")
     public RequestBuilder setReplicationType(String replicationType) {
         request.replicationType(replicationType);

diff --git a/src/main/java/org/elasticsearch/action/update/UpdateRequest.java b/src/main/java/org/elasticsearch/action/update/UpdateRequest.java
@@ -375,14 +375,18 @@ public boolean refresh() {
 
     /**
      * The replication type.
+     * @deprecated will be removed in 2.0.0. See https://github.com/elastic/elasticsearch/pull/10171
      */
+    @Deprecated
     public ReplicationType replicationType() {
         return this.replicationType;
     }
 
     /**
      * Sets the replication type.
+     * @deprecated will be removed in 2.0.0. See https://github.com/elastic/elasticsearch/pull/10171
      */
+    @Deprecated
     public UpdateRequest replicationType(ReplicationType replicationType) {
         this.replicationType = replicationType;
         return this;

diff --git a/src/main/java/org/elasticsearch/action/update/UpdateRequestBuilder.java b/src/main/java/org/elasticsearch/action/update/UpdateRequestBuilder.java
@@ -165,7 +165,9 @@ public UpdateRequestBuilder setRefresh(boolean refresh) {
 
     /**
      * Sets the replication type.
+     * @deprecated will be removed in 2.0.0. See https://github.com/elastic/elasticsearch/pull/10171
      */
+    @Deprecated
     public UpdateRequestBuilder setReplicationType(ReplicationType replicationType) {
         request.replicationType(replicationType);
         return this;