Share via


SPBackupRestoreConfigurationSettings Members

Include Protected Members
Include Inherited Members

Represents some farm wide settings used in backup and restore operations.

The SPBackupRestoreConfigurationSettings type exposes the following members.

Constructors

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

Top

Properties

  Name Description
Public property BackupThreads Gets or sets the number of threads used by a backup operation.
Public property CurrentBackupLocation Gets or sets the UNC path of the current backup location.
Public property CurrentBackupXml Gets or sets the full path to the current spbrtoc.xml which holds a history of backup and restore operations.
Public property CurrentIsBackup Gets or sets a value that indicates whether the current backup or restore operation is a backup operation or a restore operation.
Public property DisplayName Gets the display name that describes the persisted object instance within the administrative user interface. (Inherited from SPPersistedObject.)
Public property Farm Gets the server farm where the object resides. (Inherited from SPPersistedObject.)
Public property Id Gets or sets the GUID that is associated with the object. (Inherited from SPPersistedObject.)
Public property IsCurrentlyRunning Gets or sets a value that indicates whether the backup or restore operation is currently running.
Public property Name Gets or sets a name that is used to uniquely identify two objects that have the same parent and class. (Inherited from SPPersistedObject.)
Public property Parent Gets the parent in the logical hierarchy of the configuration object tree. (Inherited from SPPersistedObject.)
Public property PreviousBackupLocation Gets or sets the UNC path of the last backup location before the current backup location.
Public property Properties Gets metadata for the persisted object. (Inherited from SPPersistedObject.)
Public property RestoreThreads Gets or sets the number of threads used by a restoration operation.
Public property Status Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.)
Public property TypeName Gets the display name that describes the object type in the administrative user interface. (Inherited from SPPersistedObject.)
Public property UpgradedPersistedProperties Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.)
Public property Version Gets a value that is incremented each time the object is updated. (Inherited from SPPersistedObject.)
Protected property WasCreated Gets a Boolean value that indicates whether the object is initialized and can be found in the database. (Inherited from SPPersistedObject.)

Top

Methods

  Name Description
Public method ClearPreviousBackupLocation Sets PreviousBackupLocation to an empty string.
Public method Clone Returns a clone of the object that does not come from the in-memory cache, which enables calling code to help ensure thread safety. (Inherited from SPPersistedObject.)
Public methodStatic member CreateSettings Creates an SPBackupRestoreConfigurationSettings object for the farm.
Public method Delete Deletes the object. (Inherited from SPPersistedObject.)
Public method Equals Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.)
Protected method Finalize (Inherited from Object.)
Public method GetChild<T>() Returns the child of the persisted object based on the specified type. (Inherited from SPPersistedObject.)
Public method GetChild<T>(String) Returns the child object of the persisted object based on the specified name. (Inherited from SPPersistedObject.)
Public method GetHashCode Serves as a hash function for the persisted object. (Inherited from SPPersistedObject.)
Public method GetObjectData Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.)
Public method GetType (Inherited from Object.)
Protected method HasAdditionalUpdateAccess Override this method to allow more users to update the object. (Inherited from SPPersistedObject.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method OnDeserialization Raises the Deserialization event. (Overrides SPPersistedObject.OnDeserialization().)
Public method Provision Makes the changes to the local server that are needed before the object can be used. (Inherited from SPPersistedObject.)
Public method ToString Returns the type and name of an object and of all its ancestors (parent, grandparent, and so on). (Inherited from SPPersistedObject.)
Public method Uncache Frees the memory cache that is used by the object. (Inherited from SPPersistedObject.)
Public method Unprovision Makes the changes to the local server that are needed to clean up after deleting the object. (Inherited from SPPersistedObject.)
Public method Update() Causes the SPBackupRestoreConfigurationSettings object to save its state and propagate changes to all the computers in the server farm while ensuring that there is only one copy in the database. (Overrides SPPersistedObject.Update().)
Public method Update(Boolean) Causes the object to save its state and propagate changes to all the computers in the server farm, optionally throwing an exception if the object already exists in the configuration store. (Inherited from SPPersistedObject.)
Protected method UpdateParent Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.)
Protected method Validate Validates the state of all fields before persisting the object. (Inherited from SPPersistedObject.)

Top

See Also

Reference

SPBackupRestoreConfigurationSettings Class

Microsoft.SharePoint.Administration.Backup Namespace