@acceleratxr/core_sdk / Backup
Class: Backup#
Describes a single backup job to be executed immediately or on a schedule.
REQUIRES: Backup Services
author Jean-Philippe Steinmetz info@acceleratxr.com
Hierarchy#
-
↳ Backup
Index#
Constructors#
Properties#
Accessors#
Constructors#
constructor#
+ new Backup(other?: any): Backup
Overrides EntityBase.constructor
Defined in src/models/Backup.ts:59
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Backup
Properties#
active#
• active: boolean = true
Defined in src/models/Backup.ts:29
Indicates whether the backup job is currently active and will be executed.
dateCreated#
• dateCreated: Date = new Date()
Inherited from EntityBase.dateCreated
Defined in src/EntityBase.ts:18
The date and time that the object was created.
dateModified#
• dateModified: Date = new Date()
Inherited from EntityBase.dateModified
Defined in src/EntityBase.ts:23
The date and time that the object was last modified.
description#
• description: string = “”
Defined in src/models/Backup.ts:39
A textual description of the backup job.
events#
• events: string[] = []
Defined in src/models/Backup.ts:44
The list of event messages that occurred during the last job execution.
keep#
• keep: number = 5
Defined in src/models/Backup.ts:49
The total number of snapshots for this job to retain.
name#
• name: string = “”
Defined in src/models/Backup.ts:34
The unique name of the backup job.
schedule#
• schedule: string = “”
Defined in src/models/Backup.ts:54
The cron-tab style schedule of how often the job will execute. If set to null this job executes exactly once.
status#
• status: BackupStatus = BackupStatus.SCHEDULED
Defined in src/models/Backup.ts:59
The current state of the backup job.
uid#
• uid: string = uuid.v4()
Inherited from EntityBase.uid
Defined in src/EntityBase.ts:13
The universally unique identifier of the object.
version#
• version: number = 0
Inherited from EntityBase.version
Defined in src/EntityBase.ts:28
The optimistic locking version of the object.
Accessors#
ClassName#
• Staticget ClassName(): string
Defined in src/models/Backup.ts:24
Returns: string