Rename import() to bulkload() (#285)

Signed-off-by: groot <yihua.mo@zilliz.com>

src/main/java/io/milvus/client/AbstractMilvusGrpcClient.java

@@ -1187,7 +1187,7 @@ public abstract class AbstractMilvusGrpcClient implements MilvusClient {
     }
 
     @Override
-    public R<ImportResponse> importData(@NonNull ImportParam requestParam) {
+    public R<ImportResponse> bulkload(@NonNull BulkloadParam requestParam) {
         if (!clientIsReady()) {
             return R.failed(new ClientNotConnectedException("Client rpc channel is not ready"));
         }
@@ -1224,7 +1224,7 @@ public abstract class AbstractMilvusGrpcClient implements MilvusClient {
     }
 
     @Override
-    public R<GetImportStateResponse> getImportState(GetImportStateParam requestParam) {
+    public R<GetImportStateResponse> getBulkloadState(GetBulkloadStateParam requestParam) {
         if (!clientIsReady()) {
             return R.failed(new ClientNotConnectedException("Client rpc channel is not ready"));
         }
@@ -1253,7 +1253,7 @@ public abstract class AbstractMilvusGrpcClient implements MilvusClient {
     }
 
     @Override
-    public R<ListImportTasksResponse> listImportTasks(@NonNull ListImportTasksParam requestParam) {
+    public R<ListImportTasksResponse> listBulkloadTasks(@NonNull ListBulkloadTasksParam requestParam) {
         if (!clientIsReady()) {
             return R.failed(new ClientNotConnectedException("Client rpc channel is not ready"));
         }

src/main/java/io/milvus/client/MilvusClient.java

@@ -288,26 +288,26 @@ public interface MilvusClient {
     /**
      * Import data from external files, currently support JSON/Numpy format
      *
-     * @param requestParam {@link ImportParam}
+     * @param requestParam {@link BulkloadParam}
      * @return {status:result code, data:RpcStatus{msg: result message}}
      */
-    R<ImportResponse> importData(ImportParam requestParam);
+    R<ImportResponse> bulkload(BulkloadParam requestParam);
 
     /**
-     * Import data from external files, currently support JSON/Numpy format
+     * Get state of bulk a load task
      *
-     * @param requestParam {@link GetImportStateParam}
+     * @param requestParam {@link GetBulkloadStateParam}
      * @return {status:result code, data:GetImportStateResponse{status,state}}
      */
-    R<GetImportStateResponse> getImportState(GetImportStateParam requestParam);
+    R<GetImportStateResponse> getBulkloadState(GetBulkloadStateParam requestParam);
 
     /**
-     * List all import tasks
+     * List all bulk load tasks
      *
-     * @param requestParam {@link ListImportTasksParam}
+     * @param requestParam {@link ListBulkloadTasksParam}
      * @return {status:result code, data:ListImportTasksResponse{status,state}}
      */
-    R<ListImportTasksResponse> listImportTasks(ListImportTasksParam requestParam);
+    R<ListImportTasksResponse> listBulkloadTasks(ListBulkloadTasksParam requestParam);
 
     /**
      * Conducts ANN search on a vector field. Use expression to do filtering before search.

src/main/java/io/milvus/client/MilvusMultiServiceClient.java

@@ -285,21 +285,21 @@ public class MilvusMultiServiceClient implements MilvusClient {
     }
 
     @Override
-    public R<ImportResponse> importData(@NonNull ImportParam requestParam) {
+    public R<ImportResponse> bulkload(@NonNull BulkloadParam requestParam) {
         List<R<ImportResponse>> response = this.clusterFactory.getAvailableServerSettings().stream()
-                .map(serverSetting -> serverSetting.getClient().importData(requestParam))
+                .map(serverSetting -> serverSetting.getClient().bulkload(requestParam))
                 .collect(Collectors.toList());
         return handleResponse(response);
     }
 
     @Override
-    public R<GetImportStateResponse> getImportState(GetImportStateParam requestParam) {
-        return this.clusterFactory.getMaster().getClient().getImportState(requestParam);
+    public R<GetImportStateResponse> getBulkloadState(GetBulkloadStateParam requestParam) {
+        return this.clusterFactory.getMaster().getClient().getBulkloadState(requestParam);
     }
 
     @Override
-    public R<ListImportTasksResponse> listImportTasks(@NonNull ListImportTasksParam requestParam) {
-        return this.clusterFactory.getMaster().getClient().listImportTasks(requestParam);
+    public R<ListImportTasksResponse> listBulkloadTasks(@NonNull ListBulkloadTasksParam requestParam) {
+        return this.clusterFactory.getMaster().getClient().listBulkloadTasks(requestParam);
     }
 
     @Override

src/main/java/io/milvus/param/dml/ImportParam.java → src/main/java/io/milvus/param/dml/BulkloadParam.java

@@ -32,17 +32,17 @@ import java.util.List;
 import java.util.Map;
 
 /**
- * Parameters for <code>importData</code> interface.
+ * Parameters for <code>bulkload</code> interface.
  */
 @Getter
-public class ImportParam {
+public class BulkloadParam {
     private final String collectionName;
     private final String partitionName;
     private final boolean rowBased;
     private final List<String> files;
     private final Map<String, String> options = new HashMap<>();
 
-    private ImportParam(@NonNull Builder builder) {
+    private BulkloadParam(@NonNull Builder builder) {
         this.collectionName = builder.collectionName;
         this.partitionName = builder.partitionName;
         this.rowBased = builder.rowBased;
@@ -55,7 +55,7 @@ public class ImportParam {
     }
 
     /**
-     * Builder for {@link ImportParam} class.
+     * Builder for {@link BulkloadParam} class.
      */
     public static class Builder {
         private String collectionName;
@@ -137,25 +137,25 @@ public class ImportParam {
         }
 
         /**
-         * Verifies parameters and creates a new {@link ImportParam} instance.
+         * Verifies parameters and creates a new {@link BulkloadParam} instance.
          *
-         * @return {@link ImportParam}
+         * @return {@link BulkloadParam}
          */
-        public ImportParam build() throws ParamException {
+        public BulkloadParam build() throws ParamException {
             ParamUtils.CheckNullEmptyString(collectionName, "Collection name");
 
-            return new ImportParam(this);
+            return new BulkloadParam(this);
         }
     }
 
     /**
-     * Constructs a <code>String</code> by {@link ImportParam} instance.
+     * Constructs a <code>String</code> by {@link BulkloadParam} instance.
      *
      * @return <code>String</code>
      */
     @Override
     public String toString() {
-        return "ImportParam{" +
+        return "BulkloadParam{" +
                 "collectionName='" + collectionName + '\'' +
                 ", partitionName='" + partitionName + '\'' +
                 ", files='" + files.toString() + '\'' +

src/main/java/io/milvus/param/dml/GetImportStateParam.java → src/main/java/io/milvus/param/dml/GetBulkloadStateParam.java

@@ -5,13 +5,13 @@ import lombok.Getter;
 import lombok.NonNull;
 
 /**
- * Parameters for <code>getImportState</code> interface.
+ * Parameters for <code>getBulkloadState</code> interface.
  */
 @Getter
-public class GetImportStateParam {
+public class GetBulkloadStateParam {
     private final long taskID;
 
-    private GetImportStateParam(@NonNull Builder builder) {
+    private GetBulkloadStateParam(@NonNull Builder builder) {
         this.taskID = builder.taskID;
     }
 
@@ -20,7 +20,7 @@ public class GetImportStateParam {
     }
 
     /**
-     * Builder for {@link GetImportStateParam} class.
+     * Builder for {@link GetBulkloadStateParam} class.
      */
     public static class Builder {
         private Long taskID;
@@ -29,7 +29,7 @@ public class GetImportStateParam {
         }
 
         /**
-         * Sets an import task id. The id is returned from importData() interface.
+         * Sets an import task id. The id is returned from bulkload() interface.
          *
          * @param taskID id of the task
          * @return <code>Builder</code>
@@ -40,27 +40,27 @@ public class GetImportStateParam {
         }
 
         /**
-         * Verifies parameters and creates a new {@link GetImportStateParam} instance.
+         * Verifies parameters and creates a new {@link GetBulkloadStateParam} instance.
          *
-         * @return {@link GetImportStateParam}
+         * @return {@link GetBulkloadStateParam}
          */
-        public GetImportStateParam build() throws ParamException {
+        public GetBulkloadStateParam build() throws ParamException {
             if (this.taskID == null) {
                 throw new ParamException("Task ID not specified");
             }
 
-            return new GetImportStateParam(this);
+            return new GetBulkloadStateParam(this);
         }
     }
 
     /**
-     * Constructs a <code>String</code> by {@link GetImportStateParam} instance.
+     * Constructs a <code>String</code> by {@link GetBulkloadStateParam} instance.
      *
      * @return <code>String</code>
      */
     @Override
     public String toString() {
-        return "GetImportStateParam{" +
+        return "GetBulkloadStateParam{" +
                 "taskID='" + taskID + '\'' +
                 '}';
     }

src/main/java/io/milvus/param/dml/ListBulkloadTasksParam.java

@@ -0,0 +1,41 @@
+package io.milvus.param.dml;
+
+import io.milvus.exception.ParamException;
+import lombok.Getter;
+import lombok.NonNull;
+
+/**
+ * Parameters for <code>getBulkloadState</code> interface.
+ */
+@Getter
+public class ListBulkloadTasksParam {
+
+    private ListBulkloadTasksParam(@NonNull Builder builder) {
+    }
+
+    public static Builder newBuilder() {
+        return new Builder();
+    }
+
+    /**
+     * Builder for {@link ListBulkloadTasksParam} class.
+     */
+    public static class Builder {
+        private Builder() {
+        }
+
+        public ListBulkloadTasksParam build() throws ParamException {
+            return new ListBulkloadTasksParam(this);
+        }
+    }
+
+    /**
+     * Constructs a <code>String</code> by {@link ListBulkloadTasksParam} instance.
+     *
+     * @return <code>String</code>
+     */
+    @Override
+    public String toString() {
+        return "ListBulkloadTasksParam";
+    }
+}

src/main/java/io/milvus/param/dml/ListImportTasksParam.java

@@ -1,41 +0,0 @@
-package io.milvus.param.dml;
-
-import io.milvus.exception.ParamException;
-import lombok.Getter;
-import lombok.NonNull;
-
-/**
- * Parameters for <code>getImportState</code> interface.
- */
-@Getter
-public class ListImportTasksParam {
-
-    private ListImportTasksParam(@NonNull Builder builder) {
-    }
-
-    public static Builder newBuilder() {
-        return new Builder();
-    }
-
-    /**
-     * Builder for {@link ListImportTasksParam} class.
-     */
-    public static class Builder {
-        private Builder() {
-        }
-
-        public ListImportTasksParam build() throws ParamException {
-            return new ListImportTasksParam(this);
-        }
-    }
-
-    /**
-     * Constructs a <code>String</code> by {@link ListImportTasksParam} instance.
-     *
-     * @return <code>String</code>
-     */
-    @Override
-    public String toString() {
-        return "ListImportTasksParam";
-    }
-}

src/main/java/io/milvus/response/GetImportStateWrapper.java → src/main/java/io/milvus/response/GetBulkloadStateWrapper.java

@@ -9,64 +9,64 @@ import lombok.NonNull;
 import java.util.List;
 
 /**
- * Util class to wrap response of <code>getImportState</code> interface.
+ * Util class to wrap response of <code>getBulkloadState</code> interface.
  */
-public class GetImportStateWrapper {
+public class GetBulkloadStateWrapper {
     private final GetImportStateResponse response;
 
-    public GetImportStateWrapper(@NonNull GetImportStateResponse response) {
+    public GetBulkloadStateWrapper(@NonNull GetImportStateResponse response) {
         this.response = response;
     }
 
     /**
-     * Gets ID of the import task.
+     * Gets ID of the bulk load task.
      *
-     * @return Long ID of the import task
+     * @return Long ID of the bulk load task
      */
     public long getTaskID() {
         return response.getId();
     }
 
     /**
-     * Gets the long ID array for auto-id primary key, generated by import task.
+     * Gets the long ID array for auto-id primary key, generated by bulk load task.
      *
-     * @return List&lt;Long&gt; ID array returned by import task
+     * @return List&lt;Long&gt; ID array returned by bulk load task
      */
     public List<Long> getAutoGeneratedIDs() {
         return response.getIdListList();
     }
 
     /**
-     * Gets state of the import task.
+     * Gets state of the bulk load task.
      *
-     * @return ImportState state of the import task
+     * @return ImportState state of the bulk load task
      */
     public ImportState getState() {
         return response.getState();
     }
 
     /**
-     * Gets how many rows were imported by the import task.
+     * Gets how many rows were imported by the bulk load task.
      *
-     * @return Long how many rows were imported by the import task
+     * @return Long how many rows were imported by the bulk load task
      */
     public long getImportedCount() {
         return response.getRowCount();
     }
 
     /**
-     * Gets failed reason of the import task.
+     * Gets failed reason of the bulk load task.
      *
-     * @return String failed reason of the import task
+     * @return String failed reason of the bulk load task
      */
     public String getFailedReason() {
         return getInfo(Constant.FAILED_REASON);
     }
 
     /**
-     * Gets target files of the import task.
+     * Gets target files of the bulk load task.
      *
-     * @return String target files of the import task
+     * @return String target files of the bulk load task
      */
     public String getFiles() {
         return getInfo(Constant.IMPORT_FILES);
@@ -90,7 +90,7 @@ public class GetImportStateWrapper {
      */
     @Override
     public String toString() {
-        return "Import task state{" +
+        return "bulk load task state{" +
                 ", autoGeneratedIDs:" + getAutoGeneratedIDs() +
                 ", state:" + getState().name() +
                 ", failed reason:" + getFailedReason() +

src/test/java/io/milvus/client/MilvusServiceClientTest.java

@@ -1604,9 +1604,9 @@ class MilvusServiceClientTest {
     }
 
     @Test
-    void importData() {
+    void bulkload() {
         List<String> files = Collections.singletonList("f1");
-        ImportParam param = ImportParam.newBuilder()
+        BulkloadParam param = BulkloadParam.newBuilder()
                 .withCollectionName("collection1")
                 .withPartitionName("partition1")
                 .withRowBased(true)
@@ -1615,23 +1615,23 @@ class MilvusServiceClientTest {
                 .withBucket("myBucket")
                 .build();
 
-        testFuncByName("importData", param);
+        testFuncByName("bulkload", param);
     }
 
     @Test
-    void getImportState() {
-        GetImportStateParam param = GetImportStateParam.newBuilder()
+    void getBulkloadState() {
+        GetBulkloadStateParam param = GetBulkloadStateParam.newBuilder()
                 .withTaskID(100L)
                 .build();
 
-        testFuncByName("getImportState", param);
+        testFuncByName("getBulkloadState", param);
     }
 
     @Test
-    void listImportTasks() {
-        ListImportTasksParam param = ListImportTasksParam.newBuilder().build();
+    void listBulkloadTasks() {
+        ListBulkloadTasksParam param = ListBulkloadTasksParam.newBuilder().build();
 
-        testFuncByName("listImportTasks", param);
+        testFuncByName("listBulkloadTasks", param);
     }
 
     @Test
@@ -2559,7 +2559,7 @@ class MilvusServiceClientTest {
     }
 
     @Test
-    void testGetImportStateWrapper() {
+    void testGetBulkloadStateWrapper() {
         long count = 1000;
         long id = 88;
         ImportState state = ImportState.ImportStarted;
@@ -2579,7 +2579,7 @@ class MilvusServiceClientTest {
                         .build())
                 .build();
 
-        GetImportStateWrapper wrapper = new GetImportStateWrapper(reso);
+        GetBulkloadStateWrapper wrapper = new GetBulkloadStateWrapper(reso);
         assertEquals(count, wrapper.getImportedCount());
         assertEquals(1, wrapper.getAutoGeneratedIDs().size());
         assertEquals(id, wrapper.getAutoGeneratedIDs().get(0));