Simplify instantiating Data Object Request/Response builders (opensea…

…rch-project#2608) Signed-off-by: Daniel Widdis <widdis@gmail.com>
arjunkumargiri · Jul 8, 2024 · c332aa5 · c332aa5
1 parent dd71ed1
commit c332aa5
Show file tree

Hide file tree

Showing 47 changed files with 241 additions and 140 deletions.
diff --git a/common/src/main/java/org/opensearch/sdk/DeleteDataObjectRequest.java b/common/src/main/java/org/opensearch/sdk/DeleteDataObjectRequest.java
@@ -51,6 +51,14 @@ public String id() {
     public String tenantId() {
         return this.tenantId;
     }
+
+    /**
+     * Instantiate a builder for this object
+     * @return a builder instance
+     */
+    public static Builder builder() {
+        return new Builder();
+    }
 
     /**
      * Class for constructing a Builder for this Request Object
@@ -63,7 +71,7 @@ public static class Builder {
         /**
          * Empty Constructor for the Builder object
          */
-        public Builder() {}
+        private Builder() {}
 
         /**
          * Add an index to this builder

diff --git a/common/src/main/java/org/opensearch/sdk/DeleteDataObjectResponse.java b/common/src/main/java/org/opensearch/sdk/DeleteDataObjectResponse.java
@@ -42,6 +42,14 @@ public XContentParser parser() {
         return this.parser;
     }
 
+    /**
+     * Instantiate a builder for this object
+     * @return a builder instance
+     */
+    public static Builder builder() {
+        return new Builder();
+    }
+
     /**
      * Class for constructing a Builder for this Response Object
      */
@@ -52,7 +60,7 @@ public static class Builder {
         /**
          * Empty Constructor for the Builder object
          */
-        public Builder() {}
+        private Builder() {}
 
         /**
          * Add an id to this builder

diff --git a/common/src/main/java/org/opensearch/sdk/GetDataObjectRequest.java b/common/src/main/java/org/opensearch/sdk/GetDataObjectRequest.java
@@ -65,6 +65,14 @@ public FetchSourceContext fetchSourceContext() {
         return this.fetchSourceContext;
     }
 
+    /**
+     * Instantiate a builder for this object
+     * @return a builder instance
+     */
+    public static Builder builder() {
+        return new Builder();
+    }
+
     /**
      * Class for constructing a Builder for this Request Object
      */
@@ -77,7 +85,7 @@ public static class Builder {
         /**
          * Empty Constructor for the Builder object
          */
-        public Builder() {}
+        private Builder() {}
 
         /**
          * Add an index to this builder

diff --git a/common/src/main/java/org/opensearch/sdk/GetDataObjectResponse.java b/common/src/main/java/org/opensearch/sdk/GetDataObjectResponse.java
@@ -56,6 +56,14 @@ public Map<String, Object> source() {
         return this.source;
     }
 
+    /**
+     * Instantiate a builder for this object
+     * @return a builder instance
+     */
+    public static Builder builder() {
+        return new Builder();
+    }
+
     /**
      * Class for constructing a Builder for this Response Object
      */
@@ -67,7 +75,7 @@ public static class Builder {
         /**
          * Empty Constructor for the Builder object
          */
-        public Builder() {}
+        private Builder() {}
 
         /**
          * Add an id to this builder

diff --git a/common/src/main/java/org/opensearch/sdk/PutDataObjectRequest.java b/common/src/main/java/org/opensearch/sdk/PutDataObjectRequest.java
@@ -63,6 +63,14 @@ public ToXContentObject dataObject() {
         return this.dataObject;
     }
 
+    /**
+     * Instantiate a builder for this object
+     * @return a builder instance
+     */
+    public static Builder builder() {
+        return new Builder();
+    }
+
     /**
      * Class for constructing a Builder for this Request Object
      */
@@ -75,7 +83,7 @@ public static class Builder {
         /**
          * Empty Constructor for the Builder object
          */
-        public Builder() {}
+        private Builder() {}
 
         /**
          * Add an index to this builder

diff --git a/common/src/main/java/org/opensearch/sdk/PutDataObjectResponse.java b/common/src/main/java/org/opensearch/sdk/PutDataObjectResponse.java
@@ -42,6 +42,14 @@ public XContentParser parser() {
         return this.parser;
     }
 
+    /**
+     * Instantiate a builder for this object
+     * @return a builder instance
+     */
+    public static Builder builder() {
+        return new Builder();
+    }
+
     /**
      * Class for constructing a Builder for this Response Object
      */
@@ -52,7 +60,7 @@ public static class Builder {
         /**
          * Empty Constructor for the Builder object
          */
-        public Builder() {}
+        private Builder() {}
 
         /**
          * Add an id to this builder

diff --git a/common/src/main/java/org/opensearch/sdk/SearchDataObjectRequest.java b/common/src/main/java/org/opensearch/sdk/SearchDataObjectRequest.java
@@ -55,6 +55,14 @@ public SearchSourceBuilder searchSourceBuilder() {
         return this.searchSourceBuilder;
     }
 
+    /**
+     * Instantiate a builder for this object
+     * @return a builder instance
+     */
+    public static Builder builder() {
+        return new Builder();
+    }
+
     /**
      * Class for constructing a Builder for this Request Object
      */
@@ -66,7 +74,7 @@ public static class Builder {
         /**
          * Empty Constructor for the Builder object
          */
-        public Builder() {}
+        private Builder() {}
 
         /**
          * Add a indices to this builder

diff --git a/common/src/main/java/org/opensearch/sdk/SearchDataObjectResponse.java b/common/src/main/java/org/opensearch/sdk/SearchDataObjectResponse.java
@@ -29,6 +29,14 @@ public XContentParser parser() {
         return this.parser;
     }
 
+    /**
+     * Instantiate a builder for this object
+     * @return a builder instance
+     */
+    public static Builder builder() {
+        return new Builder();
+    }
+
     /**
      * Class for constructing a Builder for this Response Object
      */
@@ -38,7 +46,7 @@ public static class Builder {
         /**
          * Empty Constructor for the Builder object
          */
-        public Builder() {}
+        private Builder() {}
 
         /**
          * Add aparser to this builder

diff --git a/common/src/main/java/org/opensearch/sdk/UpdateDataObjectRequest.java b/common/src/main/java/org/opensearch/sdk/UpdateDataObjectRequest.java
@@ -69,6 +69,14 @@ public ToXContentObject dataObject() {
         return this.dataObject;
     }
 
+    /**
+     * Instantiate a builder for this object
+     * @return a builder instance
+     */
+    public static Builder builder() {
+        return new Builder();
+    }
+
     /**
      * Class for constructing a Builder for this Request Object
      */
@@ -81,7 +89,7 @@ public static class Builder {
         /**
          * Empty Constructor for the Builder object
          */
-        public Builder() {}
+        private Builder() {}
 
         /**
          * Add an index to this builder

diff --git a/common/src/main/java/org/opensearch/sdk/UpdateDataObjectResponse.java b/common/src/main/java/org/opensearch/sdk/UpdateDataObjectResponse.java
@@ -42,6 +42,14 @@ public XContentParser parser() {
         return this.parser;
     }
 
+    /**
+     * Instantiate a builder for this object
+     * @return a builder instance
+     */
+    public static Builder builder() {
+        return new Builder();
+    }
+
     /**
      * Class for constructing a Builder for this Response Object
      */
@@ -52,7 +60,7 @@ public static class Builder {
         /**
          * Empty Constructor for the Builder object
          */
-        public Builder() {}
+        private Builder() {}
 
         /**
          * Add an id to this builder

diff --git a/common/src/test/java/org/opensearch/sdk/DeleteDataObjectRequestTests.java b/common/src/test/java/org/opensearch/sdk/DeleteDataObjectRequestTests.java
@@ -27,7 +27,7 @@ public void setUp() {
 
     @Test
     public void testDeleteDataObjectRequest() {
-        DeleteDataObjectRequest request = new DeleteDataObjectRequest.Builder().index(testIndex).id(testId).tenantId(testTenantId).build();
+        DeleteDataObjectRequest request = DeleteDataObjectRequest.builder().index(testIndex).id(testId).tenantId(testTenantId).build();
 
         assertEquals(testIndex, request.index());
         assertEquals(testId, request.id());

diff --git a/common/src/test/java/org/opensearch/sdk/DeleteDataObjectResponseTests.java b/common/src/test/java/org/opensearch/sdk/DeleteDataObjectResponseTests.java
@@ -10,9 +10,6 @@
 
 import org.junit.Before;
 import org.junit.Test;
-import org.opensearch.action.support.replication.ReplicationResponse.ShardInfo;
-import org.opensearch.core.common.Strings;
-import org.opensearch.core.index.shard.ShardId;
 import org.opensearch.core.xcontent.XContentParser;
 
 import static org.junit.Assert.assertEquals;
@@ -31,7 +28,7 @@ public void setUp() {
 
     @Test
     public void testDeleteDataObjectResponse() {
-        DeleteDataObjectResponse response = new DeleteDataObjectResponse.Builder().id(testId).parser(testParser).build();
+        DeleteDataObjectResponse response = DeleteDataObjectResponse.builder().id(testId).parser(testParser).build();
 
         assertEquals(testId, response.id());
         assertEquals(testParser, response.parser());

diff --git a/common/src/test/java/org/opensearch/sdk/GetDataObjectRequestTests.java b/common/src/test/java/org/opensearch/sdk/GetDataObjectRequestTests.java
@@ -32,7 +32,7 @@ public void setUp() {
 
     @Test
     public void testGetDataObjectRequest() {
-        GetDataObjectRequest request = new GetDataObjectRequest.Builder()
+        GetDataObjectRequest request = GetDataObjectRequest.builder()
             .index(testIndex)
             .id(testId)
             .tenantId(testTenantId)

diff --git a/common/src/test/java/org/opensearch/sdk/GetDataObjectResponseTests.java b/common/src/test/java/org/opensearch/sdk/GetDataObjectResponseTests.java
@@ -31,7 +31,7 @@ public void setUp() {
 
     @Test
     public void testGetDataObjectResponse() {
-        GetDataObjectResponse response = new GetDataObjectResponse.Builder().id(testId).parser(testParser).source(testSource).build();
+        GetDataObjectResponse response = GetDataObjectResponse.builder().id(testId).parser(testParser).source(testSource).build();
 
         assertEquals(testId, response.id());
         assertEquals(testParser, response.parser());

diff --git a/common/src/test/java/org/opensearch/sdk/PutDataObjectRequestTests.java b/common/src/test/java/org/opensearch/sdk/PutDataObjectRequestTests.java
@@ -30,7 +30,7 @@ public void setUp() {
 
     @Test
     public void testPutDataObjectRequest() {
-        PutDataObjectRequest request = new PutDataObjectRequest.Builder().index(testIndex).tenantId(testTenantId).dataObject(testDataObject).build();
+        PutDataObjectRequest request = PutDataObjectRequest.builder().index(testIndex).tenantId(testTenantId).dataObject(testDataObject).build();
 
         assertEquals(testIndex, request.index());
         assertEquals(testTenantId, request.tenantId());

diff --git a/common/src/test/java/org/opensearch/sdk/PutDataObjectResponseTests.java b/common/src/test/java/org/opensearch/sdk/PutDataObjectResponseTests.java
@@ -28,7 +28,7 @@ public void setUp() {
 
     @Test
     public void testPutDataObjectResponse() {
-        PutDataObjectResponse response = new PutDataObjectResponse.Builder().id(testId).parser(testParser).build();
+        PutDataObjectResponse response = PutDataObjectResponse.builder().id(testId).parser(testParser).build();
 
         assertEquals(testId, response.id());
         assertEquals(testParser, response.parser());

diff --git a/common/src/test/java/org/opensearch/sdk/SearchDataObjectRequestTests.java b/common/src/test/java/org/opensearch/sdk/SearchDataObjectRequestTests.java
@@ -30,7 +30,7 @@ public void setUp() {
 
     @Test
     public void testGetDataObjectRequest() {
-        SearchDataObjectRequest request = new SearchDataObjectRequest.Builder()
+        SearchDataObjectRequest request = SearchDataObjectRequest.builder()
             .indices(testIndices)
             .tenantId(testTenantId)
             .searchSourceBuilder(testSearchSourceBuilder)

diff --git a/common/src/test/java/org/opensearch/sdk/SearchDataObjectResponseTests.java b/common/src/test/java/org/opensearch/sdk/SearchDataObjectResponseTests.java
@@ -26,7 +26,7 @@ public void setUp() {
 
     @Test
     public void testSearchDataObjectResponse() {
-        SearchDataObjectResponse response = new SearchDataObjectResponse.Builder().parser(testParser).build();
+        SearchDataObjectResponse response = SearchDataObjectResponse.builder().parser(testParser).build();
 
         assertEquals(testParser, response.parser());
     }

diff --git a/common/src/test/java/org/opensearch/sdk/UpdateDataObjectRequestTests.java b/common/src/test/java/org/opensearch/sdk/UpdateDataObjectRequestTests.java
@@ -40,7 +40,7 @@ public void setUp() {
 
     @Test
     public void testUpdateDataObjectRequest() {
-        UpdateDataObjectRequest request = new UpdateDataObjectRequest.Builder().index(testIndex).id(testId).tenantId(testTenantId).dataObject(testDataObject).build();
+        UpdateDataObjectRequest request = UpdateDataObjectRequest.builder().index(testIndex).id(testId).tenantId(testTenantId).dataObject(testDataObject).build();
 
         assertEquals(testIndex, request.index());
         assertEquals(testId, request.id());
@@ -50,7 +50,7 @@ public void testUpdateDataObjectRequest() {
 
     @Test
     public void testUpdateDataObjectMapRequest() {
-        UpdateDataObjectRequest request = new UpdateDataObjectRequest.Builder().index(testIndex).id(testId).tenantId(testTenantId).dataObject(testDataObjectMap).build();
+        UpdateDataObjectRequest request = UpdateDataObjectRequest.builder().index(testIndex).id(testId).tenantId(testTenantId).dataObject(testDataObjectMap).build();
 
         assertEquals(testIndex, request.index());
         assertEquals(testId, request.id());

diff --git a/common/src/test/java/org/opensearch/sdk/UpdateDataObjectResponseTests.java b/common/src/test/java/org/opensearch/sdk/UpdateDataObjectResponseTests.java
@@ -31,7 +31,7 @@ public void setUp() {
 
     @Test
     public void testUpdateDataObjectResponse() {
-        UpdateDataObjectResponse response = new UpdateDataObjectResponse.Builder().id(testId).parser(testParser).build();
+        UpdateDataObjectResponse response = UpdateDataObjectResponse.builder().id(testId).parser(testParser).build();
 
         assertEquals(testId, response.id());
         assertEquals(testParser, response.parser());

diff --git a/plugin/src/main/java/org/opensearch/ml/action/agents/DeleteAgentTransportAction.java b/plugin/src/main/java/org/opensearch/ml/action/agents/DeleteAgentTransportAction.java
@@ -83,7 +83,8 @@ protected void doExecute(Task task, ActionRequest request, ActionListener<Delete
         boolean isSuperAdmin = isSuperAdminUserWrapper(clusterService, client);
 
         FetchSourceContext fetchSourceContext = new FetchSourceContext(true, Strings.EMPTY_ARRAY, Strings.EMPTY_ARRAY);
-        GetDataObjectRequest getDataObjectRequest = new GetDataObjectRequest.Builder()
+        GetDataObjectRequest getDataObjectRequest = GetDataObjectRequest
+            .builder()
             .index(ML_AGENT_INDEX)
             .id(agentId)
             .tenantId(tenantId)
@@ -131,7 +132,8 @@ protected void doExecute(Task task, ActionRequest request, ActionListener<Delete
                                             try {
                                                 sdkClient
                                                     .deleteDataObjectAsync(
-                                                        new DeleteDataObjectRequest.Builder()
+                                                        DeleteDataObjectRequest
+                                                            .builder()
                                                             .index(deleteRequest.index())
                                                             .id(deleteRequest.id())
                                                             .tenantId(tenantId)

diff --git a/plugin/src/main/java/org/opensearch/ml/action/agents/GetAgentTransportAction.java b/plugin/src/main/java/org/opensearch/ml/action/agents/GetAgentTransportAction.java
@@ -83,7 +83,8 @@ protected void doExecute(Task task, ActionRequest request, ActionListener<MLAgen
         boolean isSuperAdmin = isSuperAdminUserWrapper(clusterService, client);
 
         FetchSourceContext fetchSourceContext = new FetchSourceContext(true, Strings.EMPTY_ARRAY, Strings.EMPTY_ARRAY);
-        GetDataObjectRequest getDataObjectRequest = new GetDataObjectRequest.Builder()
+        GetDataObjectRequest getDataObjectRequest = GetDataObjectRequest
+            .builder()
             .index(ML_AGENT_INDEX)
             .id(agentId)
             .tenantId(tenantId)

diff --git a/plugin/src/main/java/org/opensearch/ml/action/agents/TransportRegisterAgentAction.java b/plugin/src/main/java/org/opensearch/ml/action/agents/TransportRegisterAgentAction.java
@@ -86,7 +86,7 @@ private void registerAgent(MLAgent agent, ActionListener<MLRegisterAgentResponse
 
                     sdkClient
                         .putDataObjectAsync(
-                            new PutDataObjectRequest.Builder().index(ML_AGENT_INDEX).dataObject(mlAgent).build(),
+                            PutDataObjectRequest.builder().index(ML_AGENT_INDEX).dataObject(mlAgent).build(),
                             client.threadPool().executor(GENERAL_THREAD_POOL)
                         )
                         .whenComplete((r, throwable) -> {