getRestoreSnapshotState()

This operation gets the state and progress of a restore snapshot job.

Java

public GetRestoreSnapshotStateResp getRestoreSnapshotState(GetRestoreSnapshotStateReq request)

Request Syntax

Java

getRestoreSnapshotState(GetRestoreSnapshotStateReq.builder()
    .jobId(Long jobId)
    .build()
)

BUILDER METHODS:

• jobId(Long jobId)

  The restore snapshot job ID returned by restoreSnapshot().

RETURNS:

GetRestoreSnapshotStateResp

A response containing restore job state, progress, reason, timing, and collection metadata.

EXCEPTIONS:

• MilvusClientException

  This exception is raised when required parameters are missing, numeric parameters are out of range, or the server returns an error for this operation.

Example

Java

import io.milvus.v2.service.snapshot.request.GetRestoreSnapshotStateReq;
import io.milvus.v2.service.snapshot.response.GetRestoreSnapshotStateResp;

GetRestoreSnapshotStateReq request = GetRestoreSnapshotStateReq.builder()
    .jobId(123456789L)
    .build();

GetRestoreSnapshotStateResp response = client.getRestoreSnapshotState(request);