< Docs
  • Java


MilvusClient interface. This method shows the index building state, and the reason for failure (if any).

R<GetIndexStateResponse> getIndexState(GetIndexStateParam requestParam);


Use the GetIndexStateParam.Builder to construct a GetIndexStateParam object.

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

Methods of GetIndexStateParam.Builder:

Method Description Parameters
withCollectionName(collectionName) Set the collection name. Collection name cannot be empty or null. collectionName: The target collection 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 GetIndexStateParam object. N/A

The can throw the following exceptions:

  • ParamException: error if the parameter is invalid.


This method catches all the exceptions and returns an R<GetIndexStateResponse> 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 GetIndexStateResponse held by the R template.


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

GetIndexStateParam param = GetIndexStateParam.newBuilder()
R<GetIndexStateResponse> response = client.getIndexState(param)
if (response.getStatus() != R.Status.Success.getCode()) {

if (response.getData().getState() == IndexState.Failed) {

Was this page helpful?