Skip to main content

getLoadingProgress()

A MilvusClient interface. This method gets loading collection progress.

R<GetLoadingProgressResponse> getLoadingProgress(GetLoadingProgressParam requestParam);

GetLoadingProgressParam

Use the GetLoadingProgressParam.Builder to construct a GetLoadingProgressParam object.

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

Methods of GetLoadingProgressParam.Builder:

Method

Description

Parameters

withCollectionName(String collectionName)

Sets the collection name. Collection name cannot be empty or null.

collectionName: The name of the collection to load.

withDatabaseName(String databaseName)

Sets the database name. database name can be null for default database.

databaseName: The database name.

withPartitionNames(List<String> partitionNames)

Sets partition names list to specify query scope(optional).

partitionNames:
The name list of partitions to be loaded.

addPartitionName(String partitionName)

Adds a partition name to specify query scope(optional).

partitionName: A partition name.

build()

Constructs a GetLoadingProgressParam object

N/A

The GetLoadingProgressParam.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<GetLoadingProgressResponse> 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 R.Status.Success.

Example

import io.milvus.param.*;

GetLoadingProgressParam param = GetLoadingProgressParam.newBuilder()
.withCollectionName(COLLECTION_NAME)
.build();
R<GetLoadingProgressResponse> response = client.getLoadingProgress(param);
if (response.getStatus() != R.Status.Success.getCode()) {
System.out.println(response.getMessage());
}
System.out.println(response.getProgress());