getIndexBuildProgress()

MilvusClient interface. This method shows the index-building progress, such as how many rows are indexed.

R<GetIndexBuildProgressResponse> getIndexBuildProgress(GetIndexBuildProgressParam requestParam);

GetIndexBuildProgressParam

Use the GetIndexBuildProgressParam.Builder to construct a GetIndexBuildProgressParam object.

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

Methods of GetIndexBuildProgressParam.Builder:

Method	Description	Parameters
withCollectionName(collectionName)	Set the collection name. Collection name cannot be empty or null.	collectionName: The target collection name.
withDatabaseName(String databaseName)	Sets the database name. database name can be null for default database.	databaseName: The database name.
withIndexName(String indexName)	Set the target index name. If no index name is specified,the default index name is empty string which means let the server determine it.	indexName: The name of the index.
build()	Construct a GetIndexBuildProgressParam object.	N/A

The GetIndexBuildProgressParam.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<GetIndexBuildProgressResponse> 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 error message of the exception.

• If the API succeeds, it returns a valid GetIndexBuildProgressResponse held by the R template.

Example

import io.milvus.param.*;
import io.milvus.grpc.GetIndexBuildProgressResponse;

GetIndexBuildProgressParam param = GetIndexBuildProgressParam.newBuilder()
        .withCollectionName(COLLECTION_NAME)
        .withIndexName("index1")
        .build();
R<GetIndexBuildProgressResponse> response = client.getIndexBuildProgress(param);
if (response.getStatus() != R.Status.Success.getCode()) {
    System.out.println(response.getMessage());
}

long indexedRows = response.getData().getIndexedRows();
long totalRows = response.getData().getTotalRows();
System.out.println("indexed rows: "  + indexedRows + ", total rows: " + totalRows);