milvus-logo
LFAI
< Docs
  • Java
    • v1

listBulkInsertTasks()

A MilvusClient interface. This method lists bulk insert tasks.

R<ListImportTasksResponse> listBulkInsertTasks(ListBulkInsertTasksParam requestParam);

ListBulkInsertTasksParam

Use the ListBulkInsertTasksParam.Builder to construct a ListBulkInsertTasksParam object.

import io.milvus.param.ListBulkInsertTasksParam;
ListBulkInsertTasksParam.Builder builder = ListBulkInsertTasksParam.newBuilder();

Methods of ListBulkInsertTasksParam.Builder:

Method Description Parameters
withCollectionName(String collectionName) Sets the target collection name, list all tasks if the name is empty. collectionName: The name of the target collection.
withLimit(Integer limit) Specify limit count of returned tasks, list all tasks if the value is 0.
Default value is 0
limit: The limit value to control the numbe of tasks returned.
build() Constructs a GetBulkInsertStateParam object. N/A

The ListBulkInsertTasksParam.Builder.build() can throw the following exceptions:

  • ParamException: error if the parameter is invalid.

Returns

This method catches all the exceptions and returns an R<ListImportTasksResponse> object.

  • If the API fails on the server side, it returns the error code and message from the server.

  • If the API fails by RPC exception, it returns R.Status.Unknown and the error message of the exception.

  • If the API succeeds, it returns a valid ListImportTasksResponse held by the R template which you can get states of all the tasks.

Example

import io.milvus.param.bulkinsert.*;

R<ListImportTasksResponse> response = milvusClient.listBulkInsertTasks(ListBulkInsertTasksParam.newBuilder()
            .withCollectionName(COLLECTION_NAME)
            .withLimit(10)
            .build());
if (response.getStatus() != R.Status.Success.getCode()) {
    System.out.println(response.getMessage());
}