For the complete documentation index, see llms.txt.
Skip to main content
Version: 8.10

Type Alias: HistoryBackupSnapshotInfo

type HistoryBackupSnapshotInfo = object;

History Backup Snapshot Info

Detailed info of a single snapshot making up a history backup.

Properties​

failures​

readonly failures: string[];

The failures reported for this snapshot. Empty if there were none.

snapshotName​

readonly snapshotName: string;

The name of the snapshot.

startTime​

readonly startTime: string | null;

The timestamp at which the snapshot was started. Not reported when the backup was listed without snapshot detail.

state​

readonly state: string | null;

The state of the snapshot, reported verbatim by the secondary storage (for example 'SUCCESS', 'IN_PROGRESS' or 'PARTIAL'). Deliberately not a closed set: Elasticsearch and OpenSearch report different vocabularies. Not reported when the backup was listed without snapshot detail.