SPDeleteJobHistoryJobDefinition Members
Include Protected Members
Include Inherited Members
Deletes old job history entries.
The SPDeleteJobHistoryJobDefinition type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
SPDeleteJobHistoryJobDefinition | Initializes a new instance of the [Microsoft.SharePoint.Administration.SPDeleteJobHistoryJobDefinition] class. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
CanRenameOnRestore | Gets a Boolean value that indicates whether this object can be renamed at restore time. (Inherited from SPJobDefinition.) |
|
CanSelectForBackup | Gets and sets a Boolean value that indicates whether this object can be selected for backup. (Inherited from SPJobDefinition.) |
|
CanSelectForRestore | Gets and sets a Boolean value that indicates whether this object can be selected for backup. (Inherited from SPJobDefinition.) |
|
DaysToKeepHistory | Number of days to keep timer job history. The default is 7 (one week). |
|
Description | Description of the definition. (Overrides SPJobDefinition.Description.) |
|
DiskSizeRequired | Gets the disk sized required for backup. (Inherited from SPJobDefinition.) |
|
DisplayName | The localized name of the job definition. (Overrides SPJobDefinition.DisplayName.) |
|
EnableBackup | Gets a Boolean value that indicates whether the job can be involved in the backup/restore process. (Inherited from SPJobDefinition.) |
|
Farm | Gets the server farm where the object resides. (Inherited from SPPersistedObject.) |
|
HistoryEntries | Enumerate the job history entries for this job definition. (Inherited from SPJobDefinition.) |
|
Id | Gets or sets the GUID that is associated with the object. (Inherited from SPPersistedObject.) |
|
IsDisabled | Gets or sets whether the job definition should be disabled. (Inherited from SPJobDefinition.) |
|
LastRunTime | Gets the last run time of the job definition. (Inherited from SPJobDefinition.) |
|
LockType | Gets the lock type for the job definition. (Inherited from SPJobDefinition.) |
|
Name | Gets or sets a name that is used to uniquely identify two objects that have the same parent and class. (Inherited from SPPersistedObject.) |
|
Parent | Gets the parent in the logical hierarchy of the configuration object tree. (Inherited from SPPersistedObject.) |
|
Properties | Gets metadata for the persisted object. (Inherited from SPPersistedObject.) |
|
Retry | Gets or sets whether the job definition should be retried if it ends abnormally. (Inherited from SPJobDefinition.) |
|
Schedule | Gets or sets the schedule of the job definition. (Inherited from SPJobDefinition.) |
|
Server | Gets the server of the job definition. (Inherited from SPJobDefinition.) |
|
Service | Gets the service for this job definition. (Inherited from SPJobDefinition.) |
|
Status | Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.) |
|
Title | Gets or sets the title of the job definition. (Inherited from SPJobDefinition.) |
|
TypeName | Gets the display name that describes the object type in the administrative user interface. (Inherited from SPPersistedObject.) |
|
UpgradedPersistedProperties | Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.) |
|
VerboseTracingEnabled | Gets and sets a Boolean value that indicates whether verbose tracing is enabled. (Inherited from SPJobDefinition.) |
|
Version | Gets a value that is incremented each time the object is updated. (Inherited from SPPersistedObject.) |
.gif "Protected property") |
WasCreated | Gets a Boolean value that indicates whether the object is initialized and can be found in the database. (Inherited from SPPersistedObject.) |
|
WebApplication | Gets the web application for this job definition. (Inherited from SPJobDefinition.) |
Top
Methods
| Name | Description | |
|---|---|---|
|
AddBackupObjects | Adds this SPJobDefinition object to the backup/restore operation. (Inherited from SPJobDefinition.) |
|
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.) |
|
Delete | Deletes the job definition. (Inherited from SPJobDefinition.) |
|
Equals | Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.) |
|
Execute(Guid) | Execute the job definition based on the given job instance identifier. (Inherited from SPPausableJobDefinition.) |
|
Execute(SPJobState) | Deletes the job history definition based on the given job state. (Overrides SPPausableJobDefinition.Execute(SPJobState).) |
.gif "Protected method") |
Finalize | (Inherited from Object.) |
|
GetChild<T>() | Returns the child of the persisted object based on the specified type. (Inherited from SPPersistedObject.) |
|
GetChild<T>(String) | Returns the child object of the persisted object based on the specified name. (Inherited from SPPersistedObject.) |
|
GetHashCode | Serves as a hash function for the persisted object. (Inherited from SPPersistedObject.) |
|
GetObjectData | Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.) |
|
GetType | (Inherited from Object.) |
|
HasAdditionalUpdateAccess | Override this method to allow more users to update the object. (Inherited from SPPersistedObject.) |
|
MemberwiseClone | (Inherited from Object.) |
|
OnAbort | Called when a user cancels the operation. (Inherited from SPJobDefinition.) |
|
OnBackup | Called when the system is being backed up. (Inherited from SPJobDefinition.) |
|
OnBackupComplete | Called when a backup operation is complete. (Inherited from SPJobDefinition.) |
|
OnDeserialization | Called immediately after the base class deserializes itself to do additional work. (Inherited from SPPersistedObject.) |
|
OnPostRestore | Called when the system is done restoring a backup. (Inherited from SPJobDefinition.) |
|
OnPrepareBackup | Called when the system is preparing for a backup operation. (Inherited from SPJobDefinition.) |
|
OnPreRestore | Called when the system is preparing to restore a backup. (Inherited from SPJobDefinition.) |
|
OnRestore | Called when the system is being restored. (Inherited from SPJobDefinition.) |
|
Provision | Makes the changes to the local server that are needed before the object can be used. (Inherited from SPPersistedObject.) |
|
RunNow | Schedules the job for immediate execution. (Inherited from SPJobDefinition.) |
|
ToString | Returns the type and name of an object and of all its ancestors (parent, grandparent, and so on). (Inherited from SPPersistedObject.) |
|
Uncache | Frees the memory cache that is used by the object. (Inherited from SPPersistedObject.) |
|
Unprovision | Makes the changes to the local server that are needed to clean up after deleting the object. (Inherited from SPPersistedObject.) |
|
Update() | Causes the job definition to save its state and propagate changes to all machines in the farm. (Inherited from SPJobDefinition.) |
|
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.) |
|
UpdateParent | Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.) |
|
UpdateProgress | Updates the percentage of the running job that is completed for the job definition running on the current server. (Inherited from SPJobDefinition.) |
|
Validate | Validates the state of the job definition before persisting the object. (Inherited from SPJobDefinition.) |
Top