This documentation is archived and is not being maintained.

SPUpgradeJobDefinition Class

Windows SharePoint Services 3

Represents an upgrade job definition.

Namespace:  Microsoft.SharePoint.Administration
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

[SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel = true)]
public sealed class SPUpgradeJobDefinition : SPJobDefinition

Instances of this class are used to represent the job definition that is associated with an upgrade. The class is derived from the SPJobDefinition class. SPUpgradeJobDefinition objects can appear in the SPJobDefinitionCollection object that is associated with an SPTimerService object.

Use the constructor to create an instance of the SPUpgradeJobDefinition class. Specify the root object for the upgrade by setting the Object property. Specify the upgrade mode (in place or side-by-side) by setting the Mode property. Add it to a job queue by calling the Add method of the appropriate job definition collection.

When an upgrade job executes, the SPUpgradeJobDefinition object tracks its progress. Management of the upgrade itself is passed off to an instance of the Microsoft.SharePoint.Upgrade.SPManager class, which handles the work of running an upgrade or migration session. For more information, see the Execute method.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.