GetImportProgressAsync()

Gets the progress of an import job.

public async Task<BulkImportResp> GetImportProgressAsync(GetImportProgressRequest request, CancellationToken cancellationToken = default)

Request Syntax

var request = new GetImportProgressRequest
{
    JobId = "job-1"
};

BulkImportResp response = await bulkImport.GetImportProgressAsync(request);

REQUEST PARAMETERS:

  • DatabaseName (string) -

    The database the job was created in. Defaults to "default"; carried on the DB-Name header because the progress endpoint derives the database from there rather than the body.

  • JobId (string) -

    The import job ID.

  • ClusterId (string?) -

    The cloud deployment target (Zilliz Cloud only).

  • ProjectId (string?) -

    The cloud project ID (Zilliz Cloud only).

  • RegionId (string?) -

    The cloud region ID (Zilliz Cloud only).

RETURN TYPE:

Task

RETURNS:

A BulkImportResp object that contains the envelope returned by the bulk-import REST endpoint. See BulkImportResp for its members.

EXCEPTIONS:

  • MilvusException

    Thrown when the HTTP request fails or the server returns an error. Inspect the exception message for details.

Example

using Milvus.Client.V2;
using Milvus.Client.V2.Requests.Utility;
using Milvus.Client.V2.Responses.Utility;

using var bulkImport = new BulkImport(new BulkImportConfig
{
    Url = "http://localhost:19530",
    ApiKey = "..."
});

BulkImportResp response = await bulkImport.GetImportProgressAsync(new GetImportProgressRequest
{
    JobId = "job-1"
});
Console.WriteLine($"state: {response.State}, progress: {response.Progress}");

Try Managed Milvus for Free

Zilliz Cloud is hassle-free, powered by Milvus and 10x faster.

Get Started
Feedback

Was this page helpful?