RestoreFromArchiveJob

View as Markdown

Struct for a restoring documents from archive job.

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

Fields

Field	Type	Number	Description
`source_file`	`string`	1	Full path to the archive file on server.
`impersonation`	`Impersonation`	2	Impersonation information for accessing the archive target file on server.
`restore_full_archive`	`bool`	3	True to restore the entire contents of the archive. False to restore a specific document only.
`restore_object_id`	`int32`	4	If bEntireContents is false, specifies the document to restore.
`options`	`OBJRESTORINGFLAGS`	5	Bit flags that control the execution of this restoring job.
`acl_override`	`AccessControlList`	6	The overriding ACL. Can be unset.
`restore_structure_items`	repeated `MetadataStructureSelector`	7	If not empty, specifies the metadata structure items to restore.
`cloud_storage_connection_string`	`string`	8	Transport connection string.
`cloud_storage_password`	`string`	9	Package encryption password.
`configuration_id`	`string`	10	Configuration id of this restoring job.

Used by methods

IRPCVaultAdmin.RestoreFromArchive -- Imports the contents of an archive (or one object of it) into the vault, or previews the import.

Used in fields

JobDataUnion.restore_from_archive -- Restoring documents from archive job.
RestoreFromArchiveRequest.restorefromarchivejob -- The archive to import (a file on the server or cloud storage), what to import and the import options.