Deprecate isShardsAcked() in favour of isShardsAcknowledged() (#27819)

Several responses include the shards_acknowledged flag (indicating whether the
requisite number of shard copies started before the completion of the operation)
and there are two different getters used : isShardsAcknowledged() and isShardsAcked().

This PR deprecates the isShardsAcked() in favour of isShardsAcknowledged() in 
CreateIndexResponse, RolloverResponse and CreateIndexClusterStateUpdateResponse.

Closes #27784

Author: olcbean

client/rest-high-level/src/test/java/org/elasticsearch/client/documentation/IndicesClientDocumentationIT.java

@@ -190,10 +190,10 @@ public void testCreateIndex() throws IOException {
 
             // tag::create-index-response
             boolean acknowledged = createIndexResponse.isAcknowledged(); // <1>
-            boolean shardsAcked = createIndexResponse.isShardsAcked(); // <2>
+            boolean shardsAcknowledged = createIndexResponse.isShardsAcknowledged(); // <2>
             // end::create-index-response
             assertTrue(acknowledged);
-            assertTrue(shardsAcked);
+            assertTrue(shardsAcknowledged);
         }
     }
 
@@ -202,7 +202,6 @@ public void testCreateIndexAsync() throws Exception {
 
         {
             CreateIndexRequest request = new CreateIndexRequest("twitter");
-
             // tag::create-index-execute-async
             client.indices().createIndexAsync(request, new ActionListener<CreateIndexResponse>() {
                 @Override

core/src/main/java/org/elasticsearch/action/admin/indices/create/CreateIndexRequest.java

@@ -453,7 +453,7 @@ public ActiveShardCount waitForActiveShards() {
      * non-negative integer, up to the number of copies per shard (number of replicas + 1),
      * to wait for the desired amount of shard copies to become active before returning.
      * Index creation will only wait up until the timeout value for the number of shard copies
-     * to be active before returning.  Check {@link CreateIndexResponse#isShardsAcked()} to
+     * to be active before returning.  Check {@link CreateIndexResponse#isShardsAcknowledged()} to
      * determine if the requisite shard copies were all started before returning or timing out.
      *
      * @param waitForActiveShards number of active shard copies to wait on

core/src/main/java/org/elasticsearch/action/admin/indices/create/CreateIndexRequestBuilder.java

@@ -254,7 +254,7 @@ public CreateIndexRequestBuilder setUpdateAllTypes(boolean updateAllTypes) {
      * non-negative integer, up to the number of copies per shard (number of replicas + 1),
      * to wait for the desired amount of shard copies to become active before returning.
      * Index creation will only wait up until the timeout value for the number of shard copies
-     * to be active before returning.  Check {@link CreateIndexResponse#isShardsAcked()} to
+     * to be active before returning.  Check {@link CreateIndexResponse#isShardsAcknowledged()} to
      * determine if the requisite shard copies were all started before returning or timing out.
      *
      * @param waitForActiveShards number of active shard copies to wait on

core/src/main/java/org/elasticsearch/action/admin/indices/create/CreateIndexResponse.java

@@ -52,24 +52,24 @@ public class CreateIndexResponse extends AcknowledgedResponse implements ToXCont
         PARSER.declareField(constructorArg(), (parser, context) -> parser.text(), INDEX, ObjectParser.ValueType.STRING);
     }
 
-    private boolean shardsAcked;
+    private boolean shardsAcknowledged;
     private String index;
 
     protected CreateIndexResponse() {
     }
 
-    protected CreateIndexResponse(boolean acknowledged, boolean shardsAcked, String index) {
+    protected CreateIndexResponse(boolean acknowledged, boolean shardsAcknowledged, String index) {
         super(acknowledged);
-        assert acknowledged || shardsAcked == false; // if its not acknowledged, then shards acked should be false too
-        this.shardsAcked = shardsAcked;
+        assert acknowledged || shardsAcknowledged == false; // if its not acknowledged, then shardsAcknowledged should be false too
+        this.shardsAcknowledged = shardsAcknowledged;
         this.index = index;
     }
 
     @Override
     public void readFrom(StreamInput in) throws IOException {
         super.readFrom(in);
         readAcknowledged(in);
-        shardsAcked = in.readBoolean();
+        shardsAcknowledged = in.readBoolean();
         if (in.getVersion().onOrAfter(Version.V_5_6_0)) {
             index = in.readString();
         }
@@ -79,27 +79,39 @@ public void readFrom(StreamInput in) throws IOException {
     public void writeTo(StreamOutput out) throws IOException {
         super.writeTo(out);
         writeAcknowledged(out);
-        out.writeBoolean(shardsAcked);
+        out.writeBoolean(shardsAcknowledged);
         if (out.getVersion().onOrAfter(Version.V_5_6_0)) {
             out.writeString(index);
         }
     }
 
     /**
      * Returns true if the requisite number of shards were started before
-     * returning from the index creation operation.  If {@link #isAcknowledged()}
+     * returning from the index creation operation. If {@link #isAcknowledged()}
      * is false, then this also returns false.
+     * 
+     * @deprecated use {@link #isShardsAcknowledged()}
      */
+    @Deprecated
     public boolean isShardsAcked() {
-        return shardsAcked;
+        return shardsAcknowledged;
+    }
+
+    /**
+     * Returns true if the requisite number of shards were started before
+     * returning from the index creation operation. If {@link #isAcknowledged()}
+     * is false, then this also returns false.
+     */
+    public boolean isShardsAcknowledged() {
+        return shardsAcknowledged;
     }
 
     public String index() {
         return index;
     }
 
     public void addCustomFields(XContentBuilder builder) throws IOException {
-        builder.field(SHARDS_ACKNOWLEDGED.getPreferredName(), isShardsAcked());
+        builder.field(SHARDS_ACKNOWLEDGED.getPreferredName(), isShardsAcknowledged());
         builder.field(INDEX.getPreferredName(), index());
     }
 

core/src/main/java/org/elasticsearch/action/admin/indices/create/TransportCreateIndexAction.java

@@ -79,7 +79,7 @@ protected void masterOperation(final CreateIndexRequest request, final ClusterSt
                 .waitForActiveShards(request.waitForActiveShards());
 
         createIndexService.createIndex(updateRequest, ActionListener.wrap(response ->
-            listener.onResponse(new CreateIndexResponse(response.isAcknowledged(), response.isShardsAcked(), indexName)),
+            listener.onResponse(new CreateIndexResponse(response.isAcknowledged(), response.isShardsAcknowledged(), indexName)),
             listener::onFailure));
     }
 

core/src/main/java/org/elasticsearch/action/admin/indices/rollover/RolloverRequest.java

@@ -202,7 +202,7 @@ CreateIndexRequest getCreateIndexRequest() {
      * non-negative integer, up to the number of copies per shard (number of replicas + 1),
      * to wait for the desired amount of shard copies to become active before returning.
      * Index creation will only wait up until the timeout value for the number of shard copies
-     * to be active before returning.  Check {@link RolloverResponse#isShardsAcked()} to
+     * to be active before returning.  Check {@link RolloverResponse#isShardsAcknowledged()} to
      * determine if the requisite shard copies were all started before returning or timing out.
      *
      * @param waitForActiveShards number of active shard copies to wait on

core/src/main/java/org/elasticsearch/action/admin/indices/rollover/RolloverRequestBuilder.java

@@ -87,7 +87,7 @@ public RolloverRequestBuilder mapping(String type, String source) {
      * non-negative integer, up to the number of copies per shard (number of replicas + 1),
      * to wait for the desired amount of shard copies to become active before returning.
      * Index creation will only wait up until the timeout value for the number of shard copies
-     * to be active before returning.  Check {@link RolloverResponse#isShardsAcked()} to
+     * to be active before returning.  Check {@link RolloverResponse#isShardsAcknowledged()} to
      * determine if the requisite shard copies were all started before returning or timing out.
      *
      * @param waitForActiveShards number of active shard copies to wait on

core/src/main/java/org/elasticsearch/action/admin/indices/rollover/RolloverResponse.java

@@ -48,19 +48,19 @@ public final class RolloverResponse extends ActionResponse implements ToXContent
     private boolean dryRun;
     private boolean rolledOver;
     private boolean acknowledged;
-    private boolean shardsAcked;
+    private boolean shardsAcknowledged;
 
     RolloverResponse() {
     }
 
     RolloverResponse(String oldIndex, String newIndex, Set<Condition.Result> conditionResults,
-                     boolean dryRun, boolean rolledOver, boolean acknowledged, boolean shardsAcked) {
+                     boolean dryRun, boolean rolledOver, boolean acknowledged, boolean shardsAcknowledged) {
         this.oldIndex = oldIndex;
         this.newIndex = newIndex;
         this.dryRun = dryRun;
         this.rolledOver = rolledOver;
         this.acknowledged = acknowledged;
-        this.shardsAcked = shardsAcked;
+        this.shardsAcknowledged = shardsAcknowledged;
         this.conditionStatus = conditionResults.stream()
             .map(result -> new AbstractMap.SimpleEntry<>(result.condition.toString(), result.matched))
             .collect(Collectors.toSet());
@@ -105,19 +105,31 @@ public boolean isRolledOver() {
      * Returns true if the creation of the new rollover index and switching of the
      * alias to the newly created index was successful, and returns false otherwise.
      * If {@link #isDryRun()} is true, then this will also return false. If this
-     * returns false, then {@link #isShardsAcked()} will also return false.
+     * returns false, then {@link #isShardsAcknowledged()} will also return false.
      */
     public boolean isAcknowledged() {
         return acknowledged;
     }
 
     /**
      * Returns true if the requisite number of shards were started in the newly
-     * created rollover index before returning.  If {@link #isAcknowledged()} is
+     * created rollover index before returning. If {@link #isAcknowledged()} is
      * false, then this will also return false.
+     * 
+     * @deprecated use {@link #isShardsAcknowledged()}
      */
+    @Deprecated
     public boolean isShardsAcked() {
-        return shardsAcked;
+        return shardsAcknowledged;
+    }
+
+    /**
+     * Returns true if the requisite number of shards were started in the newly
+     * created rollover index before returning. If {@link #isAcknowledged()} is
+     * false, then this will also return false.
+     */
+    public boolean isShardsAcknowledged() {
+        return shardsAcknowledged;
     }
 
     @Override
@@ -136,7 +148,7 @@ public void readFrom(StreamInput in) throws IOException {
         dryRun = in.readBoolean();
         rolledOver = in.readBoolean();
         acknowledged = in.readBoolean();
-        shardsAcked = in.readBoolean();
+        shardsAcknowledged = in.readBoolean();
     }
 
     @Override
@@ -152,7 +164,7 @@ public void writeTo(StreamOutput out) throws IOException {
         out.writeBoolean(dryRun);
         out.writeBoolean(rolledOver);
         out.writeBoolean(acknowledged);
-        out.writeBoolean(shardsAcked);
+        out.writeBoolean(shardsAcknowledged);
     }
 
     @Override
@@ -163,7 +175,7 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws
         builder.field(ROLLED_OVER, rolledOver);
         builder.field(DRY_RUN, dryRun);
         builder.field(ACKNOWLEDGED, acknowledged);
-        builder.field(SHARDS_ACKED, shardsAcked);
+        builder.field(SHARDS_ACKED, shardsAcknowledged);
         builder.startObject(CONDITIONS);
         for (Map.Entry<String, Boolean> entry : conditionStatus) {
             builder.field(entry.getKey(), entry.getValue());

core/src/main/java/org/elasticsearch/action/admin/indices/rollover/TransportRolloverAction.java

@@ -140,8 +140,9 @@ public void onResponse(IndicesStatsResponse statsResponse) {
                                         activeShardsObserver.waitForActiveShards(new String[]{rolloverIndexName},
                                             rolloverRequest.getCreateIndexRequest().waitForActiveShards(),
                                             rolloverRequest.masterNodeTimeout(),
-                                            isShardsAcked -> listener.onResponse(new RolloverResponse(sourceIndexName, rolloverIndexName,
-                                                                                    conditionResults, false, true, true, isShardsAcked)),
+                                            isShardsAcknowledged -> listener.onResponse(new RolloverResponse(
+                                                                sourceIndexName, rolloverIndexName, conditionResults, false, true, true,
+                                                                isShardsAcknowledged)),
                                             listener::onFailure);
                                     } else {
                                         listener.onResponse(new RolloverResponse(sourceIndexName, rolloverIndexName, conditionResults,

core/src/main/java/org/elasticsearch/action/admin/indices/shrink/ResizeRequest.java

@@ -142,7 +142,7 @@ public String getSourceIndex() {
      * non-negative integer, up to the number of copies per shard (number of replicas + 1),
      * to wait for the desired amount of shard copies to become active before returning.
      * Index creation will only wait up until the timeout value for the number of shard copies
-     * to be active before returning.  Check {@link ResizeResponse#isShardsAcked()} to
+     * to be active before returning.  Check {@link ResizeResponse#isShardsAcknowledged()} to
      * determine if the requisite shard copies were all started before returning or timing out.
      *
      * @param waitForActiveShards number of active shard copies to wait on