Share via


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
Public method SPUsageManager() This constructor is required to be public in order to use SPFarm.Local.GetChild<SPUsageManager>()
Public method SPUsageManager(SPFarm) Constructor taking an SPFarm argument.

Top

Properties

  Name Description
Public property DeploymentLocked (Inherited from SPPersistedObject.)
Public property DisplayName Gets the display name that describes the persisted object instance within the administrative user interface. (Inherited from SPPersistedObject.)
Public property Farm Gets the server farm where the object resides. (Inherited from SPPersistedObject.)
Public property Id Gets or sets the GUID that is associated with the object. (Inherited from SPPersistedObject.)
Public propertyStatic member Local Gets an instance of the SPUsageManager, if it exists; otherwise, it gets a null value.
Public property LoggingEnabled Gets or sets a value that determines whether usage logging is enabled for this farm.
Public property Name Gets or sets a name that is used to uniquely identify two objects that have the same parent and class. (Inherited from SPPersistedObject.)
Public property Parent Gets the parent in the logical hierarchy of the configuration object tree. (Inherited from SPPersistedObject.)
Public property Properties Gets metadata for the persisted object. (Inherited from SPPersistedObject.)
Public property RegisteredUsageDefinitions Gets a SPUsageDefinitionCollection object that contains a collection of registered usage definitions.
Public property Status Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.)
Public property TypeName Gets the display name that describes the object type in the administrative user interface. (Inherited from SPPersistedObject.)
Public property UpgradedPersistedProperties Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.)
Public property UsageLogCutTime The time interval that Usage log files should be cut and start a new one. Measured in minute.
Public property 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.
Public property UsageLogDiskUsageEnabled Gets/sets value that determines if usage logging max disk space usage is enabled for this farm.
Public property 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.
Public property 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.
Public property Version Gets a value that is incremented each time the object is updated. (Inherited from SPPersistedObject.)
Protected property 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
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.)
Public methodStatic member CompareUsageDefinition Compare two SPUsageDefinitions by Name
Public method Delete Deletes the object. (Inherited from SPPersistedObject.)
Public method Equals Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.)
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 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.)
Public method LogUsage Logs the usage data to the ETW (Event Tracing for Windows) stream.
Protected method MemberwiseClone (Inherited from Object.)
Protected method OnDeserialization (Overrides SPPersistedObject.OnDeserialization().)
Protected method OnPostCreate (Inherited from SPPersistedObject.)
Protected method OnPreCreate (Inherited from SPPersistedObject.)
Public method Provision Makes the necessary changes to the local server to use the object. (Overrides SPPersistedObject.Provision().)
Public method RunWithConcurrencyRetries (Inherited from SPPersistedObject.)
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 Makes the changes to the local server that are needed to clean up after deleting the object. (Inherited from SPPersistedObject.)
Public method Update() Stores this object's properties. (Overrides SPPersistedObject.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 UpdateWithNoObjectCallbackCheck (Inherited from SPPersistedObject.)
Protected method Validate Validates the state of all fields before persisting the object. (Inherited from SPPersistedObject.)

Top

See also

Reference

SPUsageManager class

Microsoft.SharePoint.Administration namespace