SPUsageManager members

The public properties of the SPUsageManager class define the configuration settings for the usage system.

The SPUsageManager type exposes the following members.

Constructors

	Name	Description
	SPUsageManager()	This constructor is required to be public in order to use SPFarm.Local.GetChild<SPUsageManager>()
	SPUsageManager(SPFarm)	Constructor taking an SPFarm argument.

Top

Properties

	Name	Description
	DeploymentLocked	(Inherited from SPPersistedObject.)
	DisplayName	Gets the display name that describes the persisted object instance within the administrative user interface. (Inherited from SPPersistedObject.)
	Farm	Gets the server farm where the object resides. (Inherited from SPPersistedObject.)
	Id	Gets or sets the GUID that is associated with the object. (Inherited from SPPersistedObject.)
	Local	Gets an instance of the SPUsageManager, if it exists; otherwise, it gets a null value.
	LoggingEnabled	Gets or sets a value that determines whether usage logging is enabled for this farm.
	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.)
	RegisteredUsageDefinitions	Gets a SPUsageDefinitionCollection object that contains a collection of registered usage definitions.
	Status	Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.)
	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.)
	UsageLogCutTime	The time interval that Usage log files should be cut and start a new one. Measured in minute.
	UsageLogDir	The directory for storing usage log files. This setting is separate from the LogDir setting used for ULS logs. The default location is the same as LogDir.
	UsageLogDiskUsageEnabled	Gets/sets value that determines if usage logging max disk space usage is enabled for this farm.
	UsageLogMaxFileSize	Indicates the maxmimum size of Usage log files. When the maximum is reached, the current log file will be closed and a new one will be generated so that logging can resume. Measured in bytes.
	UsageLogMaxSpaceGB	This member is reserved for internal use and is not intended to be used directly from your code. The maximum amount of space allowed for usage logs. When this threshold is reached, delete the oldest log(s) until enough space is available. Measured in GB.
	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.)
	CompareUsageDefinition	Compare two SPUsageDefinitions by Name
	Delete	Deletes the object. (Inherited from SPPersistedObject.)
	Equals	Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.)
	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.)
	LegacyUpdate	(Inherited from SPPersistedObject.)
	LogUsage	Logs the usage data to the ETW (Event Tracing for Windows) stream.
	MemberwiseClone	(Inherited from Object.)
	OnDeserialization	(Overrides SPPersistedObject.OnDeserialization().)
	OnPostCreate	(Inherited from SPPersistedObject.)
	OnPreCreate	(Inherited from SPPersistedObject.)
	Provision	Makes the necessary changes to the local server to use the object. (Overrides SPPersistedObject.Provision().)
	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.)
	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()	Stores this object's properties. (Overrides SPPersistedObject.Update().)
	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 state of all fields before persisting the object. (Inherited from SPPersistedObject.)

Top

See also

Reference

SPUsageManager class

Microsoft.SharePoint.Administration namespace