RecoveryRetentionEntry

Parameters and properties

• revisionOptional
  string | undefined
  Transport revision of the object, or of a journal’s index; deletion is conditional on it.
• objectsOptional
  readonly TransportEntry[] | undefined
  Versioned objects removed with the entry: a journal’s index and segments, or one cache object. Each is deleted only at its recorded revision.
• pathRequired
  string
  Host path of a .outpost entry, or an object key for journals, cache entries and every entry of a transport plan.
• categoryRequired
  string
  Storage category, such as workspaces, logs, task-cache, recovery, locks or checkpoints.
• bytesRequired
  number
  Bytes of the entry: file sizes of a directory, or the index and segments of a journal.
• eligibleRequired
  boolean
  Whether pruneRecoveryRetention() will try to remove the entry; true only when reason is ELIGIBLE.
• reasonRequired
  string
  ELIGIBLE or the code that keeps the entry, such as SCOPE_NOT_SELECTED, RETENTION_AGE, DIRTY_WORKSPACE, INCOMPLETE_INVENTORY or RECOVERY_DATA_PROTECTED.
• branchOptional
  string | undefined
  Branch checked out in a registered worktree; pruning requires it unchanged and keeps it.
• headOptional
  string | undefined
  HEAD commit of a registered worktree; pruning requires it unchanged.
• modifiedAtOptional
  string | undefined
  ISO timestamp of the latest modification inside the entry, compared with minAgeMs.

Signature

export interface RecoveryRetentionEntry {
  readonly revision?: string;
  readonly objects?: readonly TransportEntry[];
  readonly path: string;
  readonly category: string;
  readonly bytes: number;
  readonly eligible: boolean;
  readonly reason: string;
  readonly branch?: string;
  readonly head?: string;
  readonly modifiedAt?: string;
}

Related contracts

• TransportEntry