ArchiveDocsJob

View as Markdown

Struct for a job of archiving whole documents.

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

Fields

Field	Type	Number	Description
`target_path`	`string`	1	Full path to the target file on server.
`impersonation`	`Impersonation`	2	Impersonation information for accessing the archive target files on server.
`options`	`OBJARCHIVINGFLAGS`	3	Bit flags that control the execution of this archiving job.
`object_filter`	`SearchConditionArray`	4	The conditions that limit the object set of this archiving job.
`last_run_timestamp_utc`	`google.protobuf.Timestamp`	5	If indicated by OBJARCHIVINGFLAG_DELTA, only changes newer than this timestamp are archived. In UTC.
`structure_items`	repeated `ExportStructureItem`	6	The metadata structure items which will be exported.
`cloud_storage_connection_string`	`string`	7	Full path to the target file on server.
`cloud_storage_password`	`string`	8	Full path to the target file on server.
`configuration_id`	`string`	9	Configuration id of this archiving job.

Used by methods

IRPCVaultAdmin.ArchiveDocuments -- Exports (archives) the objects that match a filter into an archive package, or previews how many would be archived.

Used in fields

JobDataUnion.archive_objects -- Archiving documents job.
ArchiveDocumentsRequest.archive_job -- The objects to archive (object_filter), the destination and the options.