BackupJob

View as Markdown

Struct for a backup job.

Full name	`MFiles.BackupJob`
Proto file	`mfiles/structs.proto`

Fields

Field	Type	Number	Description
`vault_guid`	`string`	1	The GUID of the vault, or GUID_NULL if defining a backup of the master database.
`type`	`BackupType`	2	Backup type (e.g. full or differential).Values: `BACKUP_TYPE_FULL` (0), `BACKUP_TYPE_DIFFERENTIAL` (1).
`target_file`	`string`	3	Full path to the target file on server.
`impersonation`	`Impersonation`	4	Impersonation information for accessing the backup target file on server.
`overwrite_existing_files`	`bool`	5	If true, existing target files are overwritten. If false, backup fails if a target file already exists.
`file_size_limit_in_mb`	`uint32`	6	Maximum size of one backup file in megabytes. If exceeded, backup will continue in a new sequentially numbered file. If zero, file size is unlimited and the backup will always consist of a single file only.

Used by methods

IRPCServerAdmin.BackUp -- Starts a backup of a vault or of the master database as a server job and returns the job ID.
IRPCVaultsAdmin.BackUpVault -- Backs up a vault into a backup file on the server.

Used in fields

JobDataUnion.backup -- Backup job.
BackUpRequest.backupjob -- What to back up and where. Set vault_guid to the vault, or to {00000000-0000-0000-0000-000000000000} for the master database. See BackupJob.
BackUpVaultRequest.backupjob -- The backup to make: the vault (vault_guid), full or differential (type), the target file on the server and whether to overwrite it.