Class Backup

constructor

• new Backup(userClient, backupProps, parentServer): Backup

• Parameters

  • userClient: UserClient
  • backupProps: RawBackup
  • parentServer: Server

  Returns Backup

Readonlybytes

Readonlychecksum

Optional Readonlycompleted_at

Readonlycreated_at

Readonlyignored_files

is_locked

Readonlyis_successful

Readonlyname

ReadonlyparentServer

Readonlyuuid

delete

• delete(): Promise<void>

• Delete this backup

  Returns Promise<void>

downloadStream

• downloadStream(): Promise<Buffer>

• Download this backup

  Returns Promise<Buffer>

downloadUrl

• downloadUrl(): Promise<URL>

• Get a one time download url this backup

  Returns Promise<URL>

lock

• lock(): Promise<void>

• Lock this backup

  Returns Promise<void>

restore

• restore(deleteFiles?): Promise<void>

• Restore this backup

  Parameters

  • deleteFiles: boolean = false

  Returns Promise<void>

unlock

• unlock(): Promise<void>

• Unlock this backup

  Returns Promise<void>