SPRestoreSettings members

Represents the configuration settings for a restore operation. The settings include the method of restoration, the backup to be restored, and farm logon information.

The SPRestoreSettings type exposes the following members.

Constructors

  Name Description
Public method SPRestoreSettings Initializes a new instance of the SPRestoreSettings class.

Top

Properties

  Name Description
Public property BackupDevice Gets or sets the UNC path where the backup is stored. (Inherited from SPBackupRestoreSettings.)
Public property BackupId Gets or sets the ID of the backup that is restored.
Public property BackupMethod Gets or sets the backup method that will be used or was used. (Inherited from SPBackupRestoreSettings.)
Public property ConfigurationOnly Gets or sets a value that indicates whether the backup or restore operation should include only configuration settings. (Inherited from SPBackupRestoreSettings.)
Public property FarmAdminLoginName Gets or sets the logon name of the administrator of the server farm.
Public property FarmAdminPassword Gets or sets the password of the administrator of the server farm.
Public property IndividualItem Gets or sets the content component that is backed up or restored. (Inherited from SPBackupRestoreSettings.)
Public property IsBackup Gets a value that indicates whether the operation is a backup or a restore. (Inherited from SPBackupRestoreSettings.)
Public property IsVerbose Gets or sets a value that indicates whether the output of the operation is displayed on the console in addition to being logged. (Inherited from SPBackupRestoreSettings.)
Public property PreserveContentDatabaseChangeLog Gets or sets a value that indicates whether the change log of the target content database should be preserved when a restoration overwrites the database.
Public property RestoreMethod Gets or sets a value indicating whether the restore overwrites the existing database if it already exists on the target.
Public property RestoreThreads Gets or sets the number of threads to use in the restoration operation.
Public property UpdateProgress Gets or sets a value that specifies at what points the operation should report its progress. (Inherited from SPBackupRestoreSettings.)
Public property UpgradedPersistedProperties Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.)

Top

Methods

  Name Description
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetObjectData Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method OnDeserialization Called after the object has been deserialized from the file system cache or the database. (Inherited from SPAutoSerializingObject.)
Public method ToString (Inherited from Object.)
Protected method UpdateParent Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.)
Public method Validate Ensures that the correct type of SPBackupRestoreSettings-derived object is being used to hold the settings for the operation. (Inherited from SPBackupRestoreSettings.)

Top

See also

Reference

SPRestoreSettings class

Microsoft.SharePoint.Administration.Backup namespace