models.restore_site_params module

class models.restore_site_params.RestoreSiteParams(dst_site_name=None, dst_site_uuid=None, dst_site_web_url=None, restore_template=None, restore_to_original=None, site_owner_vec=None, site_result=None, snap_fs_relative_template_path=None, source_site_name=None, source_site_uuid=None, source_web_url=None, target_doc_lib_name=None, target_doc_lib_prefix=None, target_site=None)[source]

Bases: object

Implementation of the ‘RestoreSiteParams’ model.

TODO: Type model description here.

dst_site_name (string): Entity name of target site in case of

sharepoint restore.

dst_site_uuid (string): Entity uuid of target site in case of

sharepoint restore.

dst_site_web_url (string): Entity web url of target site in case of

sharepoint restore.

restore_template (bool): Indicates that we have to restore the

Sharepoint site template also. This includes: 1) Create site if it does not exist. 2) Provision template.

restore_to_original (bool): Whether or not all sites are restored to

original location.

site_owner_vec (list of RestoreSiteParams_SiteOwner): The list of

sites whose drives are being restored.

site_result (SiteBackupStatus): Site template backup status returned

by the agent on successful site backup.

snap_fs_relative_template_path (string): SnapFS relative path where

the template data is stored.

source_site_name (string): Entity name of source site in case of

sharepoint restore.

source_site_uuid (string): Entity uuid of source site in case of

sharepoint restore.

source_web_url (string): Entity web url of source site in case of

sharepoint restore.

target_doc_lib_name (string): Incase of alternate restore of granular

items within document repositiories of sites to another site, a doc lib name has to be specified by the caller. NOTE: It can be safely assumed that this field will only be present in case of granular items restore only.

target_doc_lib_prefix (string): If alternate site is provided,

customer may want to provide a custom prefix to document libraries that we create. In any case we would also have to distinguish the newly created document library as the alternate site provided by the customer may as well turn out to be the original backup site.

target_site (EntityProto): This is the site in whose drive the items will be restored.

classmethod from_dictionary(dictionary)[source]

Creates an instance of this model from a dictionary


dictionary (dictionary): A dictionary representation of the object as obtained from the deserialization of the server’s response. The keys MUST match property names in the API description.


object: An instance of this structure class.