SPDiagnosticsProvider methods

  • Article

The SPDiagnosticsProvider type exposes the following members.

Methods

  Name Description
Public method AddBackupObjects Adds this SPJobDefinition object to the backup/restore operation. (Inherited from SPJobDefinition.)
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.)
Protected method CreateHelperTable Creates the helper table in the logging database.
Protected method CreateStoredProcedure Creates or alters the specified stored procedure object.
Public method CreateTable Creates a table in the logging store.
Public method Delete When the timer job is deleted, the data associated with that job will be deleted as well. (Overrides SPJobDefinition.Delete().)
Public methodStatic member DisableAll Ensures that the default set of providers exists and enables all providers contained in the farm.
Public methodStatic member DisableProvider<TProvider> Disable diagnostic provider according to its type
Protected method DropHelperTable Deletes the helper table from the database.
Protected method DropStoredProcedure Deletes the helper stored procedure from the database.
Public method DropTable Drop the tables in the logging store
Public methodStatic member EnableAll Enable all the providers in a specific farm.
Public methodStatic member EnableProvider<TProvider> Enable diagnostic provider according to its type
Protected method Ensure Makes sure that the backing data structures are in place.
Public method Equals Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.)
Public method Execute Called by the timer job at scheduled intervals to execute data collection activities associated with this provider. (Overrides SPJobDefinition.Execute(Guid).)
Public method ExecuteNonQuery Executes a Transact-SQL query that does not return any rows.
Public method ExecuteReader Executes a Transact-SQL query that returns a rowset.
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 GetLastSyncUtc(String) The DateTime of the most recent data written to Usage database in UTC format.
Public method GetLastSyncUtc(String, String) The DateTime of the most recent data written to Usage database in UTC format.
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.)
Public method LegacyUpdate (Inherited from SPPersistedObject.)
Protected method MemberwiseClone (Inherited from Object.)
Public method OnAbort Called when a user cancels the operation. (Inherited from SPJobDefinition.)
Public method OnBackup Called when the system is being backed up. (Inherited from SPJobDefinition.)
Public method OnBackupComplete Called when a backup operation is complete. (Inherited from SPJobDefinition.)
Protected method OnDeserialization Called immediately after the base class deserializes itself to do additional work. (Inherited from SPPersistedObject.)
Protected method OnPostCreate (Inherited from SPPersistedObject.)
Public method OnPostRestore Called when the system is done restoring a backup. (Inherited from SPJobDefinition.)
Protected method OnPreCreate (Inherited from SPJobDefinition.)
Public method OnPrepareBackup Called when the system is preparing for a backup operation. (Inherited from SPJobDefinition.)
Public method OnPreRestore Called when the system is preparing to restore a backup. (Inherited from SPJobDefinition.)
Public method OnProvisioning This method is called to allow providers to perform any kind of initialization of SQL database, such as creation of tables and/or stored procedures.
Public method OnRestore Called when the system is being restored. (Inherited from SPJobDefinition.)
Public method OnUnprovisioning This method is called to allow providers to perform any kind of initialization of SQL database, such as creation of tables and/or stored procedures.
Public method Provision Makes the changes to the local server that are needed before the object can be used. (Inherited from SPPersistedObject.)
Public methodStatic member ProvisionAll Provision all the providers
Public method RunNow Schedules the job for immediate execution. (Inherited from SPJobDefinition.)
Public method RunWithConcurrencyRetries (Inherited from SPPersistedObject.)
Public method Sync Override this method to collect your data and write it to the database using WriteDataRowToServer()
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 This method is called to delete all database objects associated with the provider. (Overrides SPPersistedObject.Unprovision().)
Public method Update() Causes this SPDiagnosticsProvider to save its state. (Overrides SPJobDefinition.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.)
Public method UpdateProgress Updates the percentage of the running job that is completed for the job definition running on the current server. (Inherited from SPJobDefinition.)
Public method UpdateWithNoObjectCallbackCheck (Inherited from SPPersistedObject.)
Protected method Validate Validates the state of the job definition before persisting the object. (Inherited from SPJobDefinition.)
Public method WriteDataRowToServer(DateTime, String, []) Writes supplied data to Usage database.
Public method WriteDataRowToServer(String, IList<SPColumnDefinition>, DateTime, String, []) Writes a row of data into a table in the logging store. The table should have been created with CreateTable(String, IList<SPColumnDefinition>)CreateTable(String, IList<SPColumnDefinition>).

Top

See also

Reference

SPDiagnosticsProvider class

Microsoft.SharePoint.Diagnostics namespace