listSnapshots()

This operation lists snapshots, optionally scoped to a database and collection.

Java

public ListSnapshotsResp listSnapshots(ListSnapshotsReq request)

Request Syntax

Java

listSnapshots(ListSnapshotsReq.builder()
    .databaseName(String databaseName)
    .collectionName(String collectionName)
    .build()
)

BUILDER METHODS:

• databaseName(String databaseName)

  The name of the database that contains the collection. If omitted, the current database is used.

• collectionName(String collectionName)

  The name of the collection associated with the snapshot operation.

RETURNS:

ListSnapshotsResp

A response containing the snapshot names that match the request filter.

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.ListSnapshotsReq;
import io.milvus.v2.service.snapshot.response.ListSnapshotsResp;

ListSnapshotsReq request = ListSnapshotsReq.builder()
    .databaseName("default")
    .collectionName("book_chunks")
    .build();

ListSnapshotsResp response = client.listSnapshots(request);