@camunda8/orchestration-cluster-api
    Preparing search index...

    Type Alias HistoryBackupInfo

    History Backup Info

    Detailed status of a history backup. The aggregated state is computed from the state of each of its snapshots as:

    • If every expected snapshot exists and all are complete, the overall state is 'COMPLETED'.
    • If one snapshot failed or is partial, the overall state is 'FAILED'.
    • Otherwise, if one snapshot is incompatible, the overall state is 'INCOMPATIBLE'.
    • Otherwise, if one snapshot is still running, the overall state is 'IN_PROGRESS'.
    • Otherwise, if snapshots are missing and the backup has not progressed within the configured timeout, the overall state is 'INCOMPLETE'.
    type HistoryBackupInfo = {
        backupId: BackupId;
        details: HistoryBackupSnapshotInfo[];
        failureReason: string | null;
        state: HistoryBackupStateCode;
    }
    Index
    backupId details failureReason state
    backupId: BackupId

    The id of the backup.

    details: HistoryBackupSnapshotInfo[]

    Detailed status of the backup per snapshot. Always lists every snapshot found for the backup; when the backup was read without snapshot detail, each entry carries only its name.

    failureReason: string | null

    Reason for failure if the state is 'FAILED'.

    state: HistoryBackupStateCode

    The aggregated state of the backup.

    Settings
    Member Visibility

    On This Page
    Properties