SPTimerJobUsageDefinition members

Usage definition for timer jobs.

The SPTimerJobUsageDefinition type exposes the following members.

Constructors

	Name	Description
	SPTimerJobUsageDefinition()	Initializes a new instance of the SPTimerJobUsageDefinition class.
	SPTimerJobUsageDefinition(SPFarm)	Initializes a new instance of the SPTimerJobUsageDefinition class within the given farm.

Top

Properties

	Name	Description
	Columns	A two-dimensional array that provides the column name and SQL database type used to store data for this usage provider. (Overrides SPUsageProvider.Columns.)
	DaysToKeepData	Gets or sets the number of days to keep data. (Inherited from SPUsageDefinition.)
	DaysToKeepDetailedData	The number of days to keep data. (Inherited from SPUsageProvider.)
	DaysToKeepUsageFiles	This property controls the number of days to keep detailed data. Must be less than DaysToKeepDetailedData. (Inherited from SPUsageDefinition.)
	DeploymentLocked	(Inherited from SPPersistedObject.)
	Description	Retrieves a description of this type of SPTimerJobUsageDefinition. (Overrides SPUsageDefinition.Description.)
	DisplayName	Gets the display name that describes the persisted object instance within the administrative user interface. (Inherited from SPPersistedObject.)
	Enabled	Gets or sets a value specifying whether usage logging has been enabled for this type. (Inherited from SPUsageDefinition.)
	EnableReceivers	Gets or sets a value indicating whether usage receivers are enabled for this usage type. (Inherited from SPUsageDefinition.)
	Farm	Gets the server farm where the object resides. (Inherited from SPPersistedObject.)
	Hidden	Gets a Boolean value that determines whether the usage definition is shown in the user interface. (Inherited from SPUsageDefinition.)
	Id	Gets or sets the GUID that is associated with the object. (Inherited from SPPersistedObject.)
	Local	Retrieves an instance of this usage definition from the local farm. If an instance does not exist a new instance is returned.
	MaxTotalSizeInBytes	This property stores the maximum SQL storage size for the data of this provider. (Inherited from SPUsageDefinition.)
	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.)
	ProvisionSchema	Indicates whether this usage provider should have schema provision in the logging store. (Inherited from SPUsageProvider.)
	Receivers	Gets this usage definition's collection of receivers. (Inherited from SPUsageDefinition.)
	RetentionPeriod	The number of days to keep data for this provider. (Inherited from SPUsageProvider.)
	Status	Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.)
	TableName	Primary unique name given to objects created in the logging store for this usage provider. (Overrides SPUsageProvider.TableName.)
	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.)
	UsageDatabaseEnabled	(Inherited from SPUsageDefinition.)
	UsageEntryType	Retrieves the type of the SPUsageEntry class that corresponds to this SPTimerJobUsageDefinition. (Overrides SPUsageDefinition.UsageEntryType.)
	Version	Gets a value that is incremented each time the object is updated. (Inherited from SPPersistedObject.)
	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
	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.)
	CreateTable	Creates a table in the logging store. (Inherited from SPUsageProvider.)
	Delete	Deletes the object. (Inherited from SPPersistedObject.)
	Equals	Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.)
	ExecuteNonQuery	Executes a Transact-SQL query that does not return any rows. (Inherited from SPUsageProvider.)
	ExecuteReader	Executes a Transact-SQL query that returns a rowset. (Inherited from SPUsageProvider.)
	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.)
	ImportEntries	Uploads page request usage entries to corresponding import table in Usage Database. (Inherited from SPUsageProvider.)
	LegacyUpdate	(Inherited from SPPersistedObject.)
	MemberwiseClone	(Inherited from Object.)
	OnDeserialization	Called immediately after the base class deserializes itself to do additional work. (Inherited from SPPersistedObject.)
	OnPostCreate	(Inherited from SPPersistedObject.)
	OnPreCreate	(Inherited from SPPersistedObject.)
	OnProvisioning	This method is called to allow providers to perform any kind of SQL database initialization such as creation of tables or stored procedures. (Inherited from SPUsageProvider.)
	OnUnprovisioning	This method is called to allow providers to revert any actions performed during provisioning of the provider. (Inherited from SPUsageProvider.)
	ParseLogFileCommonEntry	Parse string array to usage table common columns: FarmId, UserLogin, SiteSubscriptionId, LogTime, and CorrelationId. (Inherited from SPUsageProvider.)
	ParseLogFileEntry([])	(Overrides SPUsageProvider.ParseLogFileEntry([]).)
	ParseLogFileEntry(String)	(Inherited from SPUsageProvider.)
	ProcessData	Called daily by the usage processing timer job. Can be used to process and/or aggregate data for this usage definition. (Inherited from SPUsageDefinition.)
	Provision	Makes the changes to the local server that are needed before the object can be used. (Inherited from SPPersistedObject.)
	RunWithConcurrencyRetries	(Inherited from SPPersistedObject.)
	ToString	Returns the type and name of an object and of all its ancestors (parent, grandparent, and so on). (Inherited from SPPersistedObject.)
	TruncateData	Called daily by the usage processing timer job. Can be used to purge all data for this usage definition. (Inherited from SPUsageDefinition.)
	TryGetDateTime	(Inherited from SPUsageProvider.)
	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()	Updates this usage provider in the configuration database. (Inherited from SPUsageProvider.)
	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.)
	UpdateWithNoObjectCallbackCheck	(Inherited from SPPersistedObject.)
	Validate	Validates the properties of this usage definition (Inherited from SPUsageDefinition.)
	WriteDataRowToServer	Writes a row of data into a table in the logging store. (Inherited from SPUsageProvider.)

Top

See also

Reference

SPTimerJobUsageDefinition class

Microsoft.SharePoint.Administration namespace