Krill SDK/krill.zone.shared.krillapp.server.backup/BackupMetaData

BackupMetaData

@Serializable

data class BackupMetaData(val name: String = "", val backupPath: String = "", val includeSnapshotData: Boolean = true, val includeProjectData: Boolean = true, val includeCameraThumbnails: Boolean = true, val maxAgeDays: Int = 0, val action: BackupAction = BackupAction.BACKUP, val restoreFile: String = "", val error: String = "", val sources: List<NodeIdentity> = emptyList(), val snapshot: Snapshot = Snapshot(), val invocationTriggers: List<InvocationTrigger> = emptyList(), val nodeAction: NodeAction = NodeAction.EXECUTE, val inputs: List<NodeIdentity> = emptyList()) : SourceMetaData(source)

Payload for a Server.Backup node.

Constructors

BackupMetaData

constructor(name: String = "", backupPath: String = "", includeSnapshotData: Boolean = true, includeProjectData: Boolean = true, includeCameraThumbnails: Boolean = true, maxAgeDays: Int = 0, action: BackupAction = BackupAction.BACKUP, restoreFile: String = "", error: String = "", sources: List<NodeIdentity> = emptyList(), snapshot: Snapshot = Snapshot(), invocationTriggers: List<InvocationTrigger> = emptyList(), nodeAction: NodeAction = NodeAction.EXECUTE, inputs: List<NodeIdentity> = emptyList())

Properties

action

@Transient

val action: BackupAction

Per-execution input: which direction (backup or restore) the next fire takes. Not serialised.

backupPath

val backupPath: String

Filesystem path on the server where archives are written / read.

error

open override val error: String

Last known error message for this node, or empty string when healthy.

includeCameraThumbnails

val includeCameraThumbnails: Boolean

When true, saved camera thumbnails are included in the archive.

includeProjectData

val includeProjectData: Boolean

When true, project / diagram files are included in the archive.

includeSnapshotData

val includeSnapshotData: Boolean

When true, snapshot history is included in the archive.

inputs

open override val inputs: List<NodeIdentity>

sets the nodes this node reads from to complete its work when invoked

invocationTriggers

open override val invocationTriggers: List<InvocationTrigger>

The set of InvocationTriggers configured to wake this node. The node processor checks the incoming event against this list before doing any work. An empty list means "never auto-fire" — only manual execution.

maxAgeDays

val maxAgeDays: Int

Maximum age of archives to keep, in days. 0 disables retention pruning.

name

val name: String

Display name shown in the editor and on the node chip.

nodeAction

open override val nodeAction: NodeAction

The action this node performs when it fires. Defaults to NodeAction.EXECUTE on every concrete implementation so that deserialising a payload that predates this field yields the original behaviour unchanged.

restoreFile

@Transient

val restoreFile: String

Per-execution input: filename of archive to restore from. Not serialised.

snapshot

open override val snapshot: Snapshot

Stores the last result of when this node was invoked and is a source of data

sources

open override val sources: List<NodeIdentity>

Upstream nodes whose values feed this one. For a filter or executor this is the data being read; for a trigger it is the value being watched.