modify based on comments

Signed-off-by: Ruirui Zhang <[email protected]>

Author: ruai0511

modules/autotagging-commons/common/src/main/java/org/opensearch/rule/RulePersistenceService.java

@@ -10,6 +10,13 @@
 
 import org.opensearch.action.support.clustermanager.AcknowledgedResponse;
 import org.opensearch.core.action.ActionListener;
+import org.opensearch.rule.action.CreateRuleRequest;
+import org.opensearch.rule.action.CreateRuleResponse;
+import org.opensearch.rule.action.DeleteRuleRequest;
+import org.opensearch.rule.action.GetRuleRequest;
+import org.opensearch.rule.action.GetRuleResponse;
+import org.opensearch.rule.action.UpdateRuleRequest;
+import org.opensearch.rule.action.UpdateRuleResponse;
 
 /**
  * Interface for a service that handles rule persistence CRUD operations.

modules/autotagging-commons/common/src/main/java/org/opensearch/rule/RuleQueryMapper.java

@@ -9,6 +9,7 @@
 package org.opensearch.rule;
 
 import org.opensearch.common.annotation.ExperimentalApi;
+import org.opensearch.rule.action.GetRuleRequest;
 
 /**
  * This interface is responsible for creating query objects which storage layer can use

modules/autotagging-commons/common/src/main/java/org/opensearch/rule/RuleRoutingService.java

@@ -9,6 +9,10 @@
 package org.opensearch.rule;
 
 import org.opensearch.core.action.ActionListener;
+import org.opensearch.rule.action.CreateRuleRequest;
+import org.opensearch.rule.action.CreateRuleResponse;
+import org.opensearch.rule.action.UpdateRuleRequest;
+import org.opensearch.rule.action.UpdateRuleResponse;
 
 /**
  * Interface that handles rule routing logic

modules/autotagging-commons/common/src/main/java/org/opensearch/rule/RuleUtils.java

@@ -9,13 +9,15 @@
 package org.opensearch.rule;
 
 import org.opensearch.common.annotation.ExperimentalApi;
+import org.opensearch.rule.action.UpdateRuleRequest;
 import org.opensearch.rule.autotagging.Attribute;
 import org.opensearch.rule.autotagging.FeatureType;
 import org.opensearch.rule.autotagging.Rule;
 
 import java.nio.charset.StandardCharsets;
 import java.time.Instant;
 import java.util.Collections;
+import java.util.List;
 import java.util.Map;
 import java.util.Optional;
 import java.util.Set;
@@ -60,12 +62,11 @@ public static String computeRuleHash(
      *  between the current rule and the one being checked.
      *
      * @param rule The rule to be validated against ruleMap.
-     * @param ruleMap This map contains existing rules to be checked
+     * @param ruleList This list contains existing rules to be checked
      */
-    public static Optional<String> getDuplicateRuleId(Rule rule, Map<String, Rule> ruleMap) {
+    public static Optional<String> getDuplicateRuleId(Rule rule, List<Rule> ruleList) {
         Map<Attribute, Set<String>> targetAttributeMap = rule.getAttributeMap();
-        for (Map.Entry<String, Rule> entry : ruleMap.entrySet()) {
-            Rule currRule = entry.getValue();
+        for (Rule currRule : ruleList) {
             Map<Attribute, Set<String>> existingAttributeMap = currRule.getAttributeMap();
 
             if (rule.getFeatureType() != currRule.getFeatureType() || targetAttributeMap.size() != existingAttributeMap.size()) {
@@ -81,7 +82,7 @@ public static Optional<String> getDuplicateRuleId(Rule rule, Map<String, Rule> r
                 }
             }
             if (allAttributesIntersect) {
-                return Optional.of(entry.getKey());
+                return Optional.of(currRule.getId());
             }
         }
         return Optional.empty();

modules/autotagging-commons/common/src/main/java/org/opensearch/rule/UpdatedRuleBuilder.java

@@ -6,7 +6,7 @@
  * compatible open source license.
  */
 
-package org.opensearch.rule;
+package org.opensearch.rule.action;
 
 import org.opensearch.action.ActionRequest;
 import org.opensearch.action.ActionRequestValidationException;

modules/autotagging-commons/common/src/main/java/org/opensearch/rule/CreateRuleRequest.java renamed to modules/autotagging-commons/common/src/main/java/org/opensearch/rule/action/CreateRuleRequest.java

@@ -6,7 +6,7 @@
  * compatible open source license.
  */
 
-package org.opensearch.rule;
+package org.opensearch.rule.action;
 
 import org.opensearch.core.action.ActionResponse;
 import org.opensearch.core.common.io.stream.StreamInput;
@@ -22,7 +22,7 @@
  * Response for the create API for Rule
  * Example response:
  * {
- *    "_id":"wi6VApYBoX5wstmtU_8l",
+ *    "id":"wi6VApYBoX5wstmtU_8l",
  *    "description":"description1",
  *    "index_pattern":["log*", "uvent*"],
  *    "workload_group":"poOiU851RwyLYvV5lbvv5w",
@@ -31,16 +31,13 @@
  * @opensearch.experimental
  */
 public class CreateRuleResponse extends ActionResponse implements ToXContent, ToXContentObject {
-    private final String _id;
     private final Rule rule;
 
     /**
      * contructor for CreateRuleResponse
-     * @param id - the id for the rule created
      * @param rule - the rule created
      */
-    public CreateRuleResponse(String id, final Rule rule) {
-        this._id = id;
+    public CreateRuleResponse(final Rule rule) {
         this.rule = rule;
     }
 
@@ -49,13 +46,11 @@ public CreateRuleResponse(String id, final Rule rule) {
      * @param in - The {@link StreamInput} instance to read from.
      */
     public CreateRuleResponse(StreamInput in) throws IOException {
-        _id = in.readString();
         rule = new Rule(in);
     }
 
     @Override
     public void writeTo(StreamOutput out) throws IOException {
-        out.writeString(_id);
         rule.writeTo(out);
     }
 

modules/autotagging-commons/common/src/main/java/org/opensearch/rule/CreateRuleResponse.java renamed to modules/autotagging-commons/common/src/main/java/org/opensearch/rule/action/CreateRuleResponse.java

@@ -6,7 +6,7 @@
  * compatible open source license.
  */
 
-package org.opensearch.rule;
+package org.opensearch.rule.action;
 
 import org.opensearch.action.ActionRequest;
 import org.opensearch.action.ActionRequestValidationException;
@@ -80,7 +80,7 @@ public String getRuleId() {
      *
      * @return The feature type.
      */
-    public FeatureType getFeatureType() {
+    FeatureType getFeatureType() {
         return featureType;
     }
 }

modules/autotagging-commons/common/src/main/java/org/opensearch/rule/DeleteRuleRequest.java renamed to modules/autotagging-commons/common/src/main/java/org/opensearch/rule/action/DeleteRuleRequest.java

@@ -6,7 +6,7 @@
  * compatible open source license.
  */
 
-package org.opensearch.rule;
+package org.opensearch.rule.action;
 
 import org.opensearch.action.ActionRequest;
 import org.opensearch.action.ActionRequestValidationException;
@@ -67,7 +67,7 @@ public GetRuleRequest(StreamInput in) throws IOException {
     @Override
     public ActionRequestValidationException validate() {
         if (RuleValidator.isEmpty(id)) {
-            throw new IllegalArgumentException(Rule._ID_STRING + " cannot be empty.");
+            throw new IllegalArgumentException(Rule.ID_STRING + " cannot be empty.");
         }
         if (RuleValidator.isEmpty(searchAfter)) {
             throw new IllegalArgumentException("search_after cannot be empty.");

modules/autotagging-commons/common/src/main/java/org/opensearch/rule/GetRuleRequest.java renamed to modules/autotagging-commons/common/src/main/java/org/opensearch/rule/action/GetRuleRequest.java

@@ -6,7 +6,7 @@
  * compatible open source license.
  */
 
-package org.opensearch.rule;
+package org.opensearch.rule.action;
 
 import org.opensearch.common.annotation.ExperimentalApi;
 import org.opensearch.core.action.ActionResponse;
@@ -18,15 +18,15 @@
 import org.opensearch.rule.autotagging.Rule;
 
 import java.io.IOException;
-import java.util.Map;
+import java.util.List;
 
 /**
  * Response for the get API for Rule.
  * Example response:
  * {
  *     "rules": [
  *         {
- *             "_id": "z1MJApUB0zgMcDmz-UQq",
+ *             "id": "z1MJApUB0zgMcDmz-UQq",
  *             "description": "Rule for tagging workload_group_id to index123"
  *             "index_pattern": ["index123"],
  *             "workload_group": "workload_group_id",
@@ -40,15 +40,15 @@
  */
 @ExperimentalApi
 public class GetRuleResponse extends ActionResponse implements ToXContent, ToXContentObject {
-    private final Map<String, Rule> rules;
+    private final List<Rule> rules;
     private final String searchAfter;
 
     /**
      * Constructor for GetRuleResponse
      * @param rules - Rules get from the request
      * @param searchAfter - The sort value used for pagination.
      */
-    public GetRuleResponse(final Map<String, Rule> rules, String searchAfter) {
+    public GetRuleResponse(final List<Rule> rules, String searchAfter) {
         this.rules = rules;
         this.searchAfter = searchAfter;
     }
@@ -58,21 +58,21 @@ public GetRuleResponse(final Map<String, Rule> rules, String searchAfter) {
      * @param in - The {@link StreamInput} instance to read from.
      */
     public GetRuleResponse(StreamInput in) throws IOException {
-        this(in.readMap(StreamInput::readString, Rule::new), in.readOptionalString());
+        this(in.readList(Rule::new), in.readOptionalString());
     }
 
     @Override
     public void writeTo(StreamOutput out) throws IOException {
-        out.writeMap(rules, StreamOutput::writeString, (outStream, rule) -> rule.writeTo(outStream));
+        out.writeList(rules);
         out.writeOptionalString(searchAfter);
     }
 
     @Override
     public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
         builder.startObject();
         builder.startArray("rules");
-        for (Map.Entry<String, Rule> entry : rules.entrySet()) {
-            entry.getValue().toXContent(builder, params);
+        for (Rule rule : rules) {
+            rule.toXContent(builder, params);
         }
         builder.endArray();
         if (searchAfter != null && !searchAfter.isEmpty()) {
@@ -85,7 +85,7 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws
     /**
      * rules getter
      */
-    public Map<String, Rule> getRules() {
+    public List<Rule> getRules() {
         return rules;
     }
 }