describeSnapshot()

この操作はスナップショットの詳細なメタデータを取得します。

java

public DescribeSnapshotResp describeSnapshot(DescribeSnapshotReq request)

リクエスト構文

java

describeSnapshot(DescribeSnapshotReq.builder()
    .databaseName(String databaseName)
    .collectionName(String collectionName)
    .snapshotName(String snapshotName)
    .build()
)

ビルダーメソッド:

• databaseName(String databaseName)

  collection を含むデータベースの名前です。省略した場合、現在のデータベースが使用されます。

• collectionName(String collectionName)

  スナップショット操作に関連付けられた collection の名前です。

• snapshotName(String snapshotName)

  スナップショットの名前です。

戻り値:

DescribeSnapshotResp

スナップショット名、説明、collection 名、partition 名、作成タイムスタンプ、保存場所を含む、スナップショットのメタデータを含むレスポンスです。

例外:

• MilvusClientException

  必須パラメータが不足している場合、数値パラメータが範囲外である場合、またはこの操作に対してサーバーがエラーを返した場合に、この例外が発生します。

例

java

import io.milvus.v2.service.snapshot.request.DescribeSnapshotReq;
import io.milvus.v2.service.snapshot.response.DescribeSnapshotResp;

DescribeSnapshotReq request = DescribeSnapshotReq.builder()
    .databaseName("default")
    .collectionName("book_chunks")
    .snapshotName("book_chunks_backup")
    .build();

DescribeSnapshotResp response = client.describeSnapshot(request);