Browse Source

renamed simulated mode to dry_run mode

Areek Zillur 9 years ago
parent
commit
9027e8a719

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

@@ -70,7 +70,7 @@ public class RolloverRequest extends AcknowledgedRequest<RolloverRequest> implem
     }
 
     private String alias;
-    private boolean simulate;
+    private boolean dryRun;
     private Set<Condition> conditions = new HashSet<>(2);
     private CreateIndexRequest createIndexRequest = new CreateIndexRequest("_na_");
 
@@ -96,7 +96,7 @@ public class RolloverRequest extends AcknowledgedRequest<RolloverRequest> implem
     public void readFrom(StreamInput in) throws IOException {
         super.readFrom(in);
         alias = in.readString();
-        simulate = in.readBoolean();
+        dryRun = in.readBoolean();
         int size = in.readVInt();
         for (int i = 0; i < size; i++) {
             this.conditions.add(in.readNamedWriteable(Condition.class));
@@ -109,7 +109,7 @@ public class RolloverRequest extends AcknowledgedRequest<RolloverRequest> implem
     public void writeTo(StreamOutput out) throws IOException {
         super.writeTo(out);
         out.writeString(alias);
-        out.writeBoolean(simulate);
+        out.writeBoolean(dryRun);
         out.writeVInt(conditions.size());
         for (Condition condition : conditions) {
             out.writeNamedWriteable(condition);
@@ -137,8 +137,8 @@ public class RolloverRequest extends AcknowledgedRequest<RolloverRequest> implem
     /**
      * Sets if the rollover should not be executed when conditions are met
      */
-    public void simulate(boolean simulate) {
-        this.simulate = simulate;
+    public void dryRun(boolean dryRun) {
+        this.dryRun = dryRun;
     }
 
     /**
@@ -163,8 +163,8 @@ public class RolloverRequest extends AcknowledgedRequest<RolloverRequest> implem
         this.createIndexRequest = Objects.requireNonNull(createIndexRequest, "create index request must not be null");;
     }
 
-    boolean isSimulate() {
-        return simulate;
+    boolean isDryRun() {
+        return dryRun;
     }
 
     Set<Condition> getConditions() {

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

@@ -46,8 +46,8 @@ public class RolloverRequestBuilder extends MasterNodeOperationRequestBuilder<Ro
         return this;
     }
 
-    public RolloverRequestBuilder simulate(boolean simulate) {
-        this.request.simulate(simulate);
+    public RolloverRequestBuilder dryRun(boolean dryRun) {
+        this.request.dryRun(dryRun);
         return this;
     }
 

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

@@ -37,7 +37,7 @@ public final class RolloverResponse extends ActionResponse implements ToXContent
     private String oldIndex;
     private String newIndex;
     private Set<Map.Entry<String, Boolean>> conditionStatus;
-    private boolean simulate;
+    private boolean dryRun;
     private boolean rolledOver;
     private boolean rolloverIndexCreated;
 
@@ -45,10 +45,10 @@ public final class RolloverResponse extends ActionResponse implements ToXContent
     }
 
     RolloverResponse(String oldIndex, String newIndex, Set<Condition.Result> conditionResults,
-                     boolean simulate, boolean rolledOver, boolean rolloverIndexCreated) {
+                     boolean dryRun, boolean rolledOver, boolean rolloverIndexCreated) {
         this.oldIndex = oldIndex;
         this.newIndex = newIndex;
-        this.simulate = simulate;
+        this.dryRun = dryRun;
         this.rolledOver = rolledOver;
         this.rolloverIndexCreated = rolloverIndexCreated;
         this.conditionStatus = conditionResults.stream()
@@ -80,8 +80,8 @@ public final class RolloverResponse extends ActionResponse implements ToXContent
     /**
      * Returns if the rollover execution was skipped even when conditions were met
      */
-    public boolean isSimulate() {
-        return simulate;
+    public boolean isDryRun() {
+        return dryRun;
     }
 
     /**
@@ -111,7 +111,7 @@ public final class RolloverResponse extends ActionResponse implements ToXContent
             conditions.add(new AbstractMap.SimpleEntry<>(condition, satisfied));
         }
         conditionStatus = conditions;
-        simulate = in.readBoolean();
+        dryRun = in.readBoolean();
         rolledOver = in.readBoolean();
         rolloverIndexCreated = in.readBoolean();
     }
@@ -126,7 +126,7 @@ public final class RolloverResponse extends ActionResponse implements ToXContent
             out.writeString(entry.getKey());
             out.writeBoolean(entry.getValue());
         }
-        out.writeBoolean(simulate);
+        out.writeBoolean(dryRun);
         out.writeBoolean(rolledOver);
         out.writeBoolean(rolloverIndexCreated);
     }
@@ -136,7 +136,7 @@ public final class RolloverResponse extends ActionResponse implements ToXContent
         builder.field(Fields.OLD_INDEX, oldIndex);
         builder.field(Fields.NEW_INDEX, newIndex);
         builder.field(Fields.ROLLED_OVER, rolledOver);
-        builder.field(Fields.SIMULATED, simulate);
+        builder.field(Fields.DRY_RUN, dryRun);
         builder.field(Fields.ROLLOVER_INDEX_CREATED, rolloverIndexCreated);
         builder.startObject(Fields.CONDITIONS);
         for (Map.Entry<String, Boolean> entry : conditionStatus) {
@@ -149,7 +149,7 @@ public final class RolloverResponse extends ActionResponse implements ToXContent
     static final class Fields {
         static final String NEW_INDEX = "new_index";
         static final String OLD_INDEX = "old_index";
-        static final String SIMULATED = "simulated";
+        static final String DRY_RUN = "dry_run";
         static final String ROLLED_OVER = "rolled_over";
         static final String ROLLOVER_INDEX_CREATED = "rollover_index_created";
         static final String CONDITIONS = "conditions";

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

@@ -106,7 +106,7 @@ public class TransportRolloverAction extends TransportMasterNodeAction<RolloverR
                     final Set<Condition.Result> conditionResults = evaluateConditions(rolloverRequest.getConditions(),
                         statsResponse.getTotal().getDocs(), metaData.index(sourceIndexName));
                     final String rolloverIndexName = generateRolloverIndexName(sourceIndexName);
-                    if (rolloverRequest.isSimulate()) {
+                    if (rolloverRequest.isDryRun()) {
                         listener.onResponse(
                             new RolloverResponse(sourceIndexName, rolloverIndexName, conditionResults, true, false,
                                 false));

+ 1 - 2
core/src/main/java/org/elasticsearch/rest/action/admin/indices/RestRolloverIndexAction.java

@@ -38,7 +38,6 @@ public class RestRolloverIndexAction extends BaseRestHandler {
     public RestRolloverIndexAction(Settings settings, RestController controller, Client client) {
         super(settings, client);
         controller.registerHandler(RestRequest.Method.POST, "/{index}/_rollover", this);
-        controller.registerHandler(RestRequest.Method.GET, "/{index}/_rollover", this);
     }
 
     @SuppressWarnings({"unchecked"})
@@ -48,7 +47,7 @@ public class RestRolloverIndexAction extends BaseRestHandler {
         if (request.hasContent()) {
             rolloverIndexRequest.source(request.content());
         }
-        rolloverIndexRequest.simulate(request.method() == RestRequest.Method.GET || request.paramAsBoolean("simulate", false));
+        rolloverIndexRequest.dryRun(request.paramAsBoolean("dry_run", false));
         rolloverIndexRequest.timeout(request.paramAsTime("timeout", rolloverIndexRequest.timeout()));
         rolloverIndexRequest.masterNodeTimeout(request.paramAsTime("master_timeout", rolloverIndexRequest.masterNodeTimeout()));
         client.admin().indices().rolloverIndex(rolloverIndexRequest, new RestToXContentListener<>(channel));

+ 8 - 8
core/src/test/java/org/elasticsearch/action/admin/indices/rollover/RolloverIT.java

@@ -39,7 +39,7 @@ public class RolloverIT extends ESIntegTestCase {
         final RolloverResponse response = client().admin().indices().prepareRolloverIndex("test_alias").get();
         assertThat(response.getOldIndex(), equalTo("test_index-1"));
         assertThat(response.getNewIndex(), equalTo("test_index-2"));
-        assertThat(response.isSimulate(), equalTo(false));
+        assertThat(response.isDryRun(), equalTo(false));
         assertThat(response.isRolledOver(), equalTo(true));
         assertThat(response.isRolloverIndexCreated(), equalTo(true));
         assertThat(response.getConditionStatus().size(), equalTo(0));
@@ -57,7 +57,7 @@ public class RolloverIT extends ESIntegTestCase {
         final RolloverResponse response = client().admin().indices().prepareRolloverIndex("test_alias").get();
         assertThat(response.getOldIndex(), equalTo("test_index-2"));
         assertThat(response.getNewIndex(), equalTo("test_index-3"));
-        assertThat(response.isSimulate(), equalTo(false));
+        assertThat(response.isDryRun(), equalTo(false));
         assertThat(response.isRolledOver(), equalTo(true));
         assertThat(response.isRolloverIndexCreated(), equalTo(true));
         assertThat(response.getConditionStatus().size(), equalTo(0));
@@ -80,7 +80,7 @@ public class RolloverIT extends ESIntegTestCase {
             .settings(settings).alias(new Alias("extra_alias")).get();
         assertThat(response.getOldIndex(), equalTo("test_index-2"));
         assertThat(response.getNewIndex(), equalTo("test_index-3"));
-        assertThat(response.isSimulate(), equalTo(false));
+        assertThat(response.isDryRun(), equalTo(false));
         assertThat(response.isRolledOver(), equalTo(true));
         assertThat(response.isRolloverIndexCreated(), equalTo(true));
         assertThat(response.getConditionStatus().size(), equalTo(0));
@@ -94,14 +94,14 @@ public class RolloverIT extends ESIntegTestCase {
         assertTrue(newIndex.getAliases().containsKey("extra_alias"));
     }
 
-    public void testRolloverSimulate() throws Exception {
+    public void testRolloverDryRun() throws Exception {
         assertAcked(prepareCreate("test_index-1").addAlias(new Alias("test_alias")).get());
         index("test_index-1", "type1", "1", "field", "value");
         flush("test_index-1");
-        final RolloverResponse response = client().admin().indices().prepareRolloverIndex("test_alias").simulate(true).get();
+        final RolloverResponse response = client().admin().indices().prepareRolloverIndex("test_alias").dryRun(true).get();
         assertThat(response.getOldIndex(), equalTo("test_index-1"));
         assertThat(response.getNewIndex(), equalTo("test_index-2"));
-        assertThat(response.isSimulate(), equalTo(true));
+        assertThat(response.isDryRun(), equalTo(true));
         assertThat(response.isRolledOver(), equalTo(false));
         assertThat(response.isRolloverIndexCreated(), equalTo(false));
         assertThat(response.getConditionStatus().size(), equalTo(0));
@@ -120,7 +120,7 @@ public class RolloverIT extends ESIntegTestCase {
             .addMaxIndexAgeCondition(TimeValue.timeValueHours(4)).get();
         assertThat(response.getOldIndex(), equalTo("test_index-0"));
         assertThat(response.getNewIndex(), equalTo("test_index-0"));
-        assertThat(response.isSimulate(), equalTo(false));
+        assertThat(response.isDryRun(), equalTo(false));
         assertThat(response.isRolledOver(), equalTo(false));
         assertThat(response.isRolloverIndexCreated(), equalTo(false));
         assertThat(response.getConditionStatus().size(), equalTo(1));
@@ -143,7 +143,7 @@ public class RolloverIT extends ESIntegTestCase {
         final RolloverResponse response = client().admin().indices().prepareRolloverIndex("test_alias").get();
         assertThat(response.getOldIndex(), equalTo("test_index-0"));
         assertThat(response.getNewIndex(), equalTo("test_index-1"));
-        assertThat(response.isSimulate(), equalTo(false));
+        assertThat(response.isDryRun(), equalTo(false));
         assertThat(response.isRolledOver(), equalTo(true));
         assertThat(response.isRolloverIndexCreated(), equalTo(false));
         final ClusterState state = client().admin().cluster().prepareState().get().getState();

+ 3 - 4
docs/reference/indices/rollover-index.asciidoc

@@ -55,9 +55,8 @@ $ curl -XPOST 'http://localhost:9200/index_alias/_rollover' -d '{
 --------------------------------------------------
 <1> Set settings to override matching index template, `mappings` and `aliases` can also be provided.
 
-Using the http `GET` method for the API runs the rollover in simulated mode, where request conditions can be
-checked without performing the actual rollover. Setting `simulate=true` as a request parameter also runs
-the request in simulated mode.
+The rollover API supports `dry_run` mode, where request conditions can be checked without performing the
+actual rollover. The `dry_run` mode can be enabled by setting `dry_run=true` as a request parameter.
 
 An example response for the index rollover API:
 
@@ -67,7 +66,7 @@ An example response for the index rollover API:
 	"old_index": "index-1", <1>
 	"new_index": "index-2", <2>
 	"rolled_over": true, <3>
-	"simulated": false, <4>
+	"dry_run": false, <4>
 	"rollover_index_created": true, <5>
 	"conditions": { <6>
 	    "[max_age: 7d]": true,