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

Type Alias: PartitionBackupInfo

type PartitionBackupInfo = object;

Partition Backup Info

Detailed info of the backup for a given partition.

Properties​

brokerId​

readonly brokerId: number | null;

The id of the broker from which the backup was taken for this partition.

brokerVersion​

readonly brokerVersion: string | null;

The version of the broker from which the backup was taken for this partition.

checkpointPosition​

readonly checkpointPosition: number | null;

The position of the checkpoint for this backup.

createdAt​

readonly createdAt: string | null;

The timestamp at which the backup was started on this partition.

failureReason​

failureReason: string | null;

Failure reason if the state is 'FAILED'.

firstLogPosition​

readonly firstLogPosition: number | null;

The first log position included in this backup.

lastUpdatedAt​

readonly lastUpdatedAt: string | null;

The timestamp at which the backup was last updated on this partition, e.g. changed state from 'IN_PROGRESS' to 'COMPLETED'.

partitionId​

partitionId: PartitionId;

The id of the partition.

snapshotId​

readonly snapshotId: string | null;

The id of the snapshot which is included in this backup.

state​

state: StateCode;

The state of the backup on this partition.