abortImport()

Aborts an existing bulk-import job.

Java

public static String abortImport(String url, BaseDescribeImportRequest request)

Request Syntax

Java

// include-start milvus
MilvusDescribeImportRequest.builder()
    .apiKey(apiKey)
    .jobId(jobId)
    .build();
// include-end
// include-start zilliz
CloudDescribeImportRequest.builder()
    .apiKey(apiKey)
    .clusterId(clusterId)
    .projectId(projectId)
    .regionId(regionId)
    .jobId(jobId)
    .build();
// include-end

MilvusDescribeImportRequest

Uses MilvusDescribeImportRequest for a Milvus deployment.

BUILDER METHODS:

• apiKey(String apiKey)

  The authentication credential. Use userName:password for Milvus or a Zilliz Cloud API key.

• jobId(String jobId)

  The import job identifier to abort.

RETURNS:

String

The JSON response body returned by the import endpoint.

EXCEPTIONS:

• Exception

  Raised when request validation, transport, or server execution fails. Inspect the exception message for the exact failure reason.

Example

Demonstrates abortImport() against Milvus.

Java

// include-start milvus
String response = BulkImportUtils.abortImport(MILVUS_URL,;
    MilvusDescribeImportRequest.builder()
        .apiKey(MILVUS_CREDENTIALS)
        .jobId(JOB_ID)
        .build());
// include-end
// include-start zilliz
String response = BulkImportUtils.abortImport(CLOUD_URL,;
    CloudDescribeImportRequest.builder()
        .apiKey(API_KEY)
        .clusterId(CLUSTER_ID)
        .jobId(JOB_ID)
        .build());
// include-end