SPUsageService members

Settings for usage logging and processing in a SharePoint Services deployment.

The SPUsageService type exposes the following members.

Constructors

	Name	Description
	SPUsageService()	Initializes a new instance of the [Microsoft.SharePoint.Administration.SPUsageService] class.
	SPUsageService(SPFarm)	Initializes a new instance of the [Microsoft.SharePoint.Administration.SPUsageService] class within the specified SharePoint farm.

Top

Properties

	Name	Description
	Applications	Gets the collection of service applications associated with the service. (Inherited from SPService.)
	AutoProvision	Available in SharePoint 2016 and later. Gets (and in some scenarios sets) a Boolean value that indicates whether the service is enabled on the farm. (Inherited from SPService.)
	CanUpgrade	Gets a value that indicates whether the object can be upgraded. (Inherited from SPPersistedUpgradableObject.)
	CompliantWithMinRole	(Inherited from SPService.)
	DeploymentLocked	(Inherited from SPPersistedObject.)
	Description	(Overrides SPService.Description.)
	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.)
	Hidden	(Overrides SPService.Hidden.)
	Id	Gets or sets the GUID that is associated with the object. (Inherited from SPPersistedObject.)
	Instances	Gets a collection of all instances of the service in the server farm. (Inherited from SPService.)
	IsBackwardsCompatible	Gets or sets a value that indicates whether the current object is backward compatible. (Inherited from SPPersistedUpgradableObject.)
	JobDefinitions	Gets a collection of job definitions for this service. (Inherited from SPService.)
	JobHistoryEntries	Gets an enumeration of the job history entries for this service. (Inherited from SPService.)
	Local	Usage service that is local to this farm.
	LoggingEnabled	Indicates whether logging is enabled for this usage application or not.
	Name	Gets or sets a name that is used to uniquely identify two objects that have the same parent and class. (Inherited from SPPersistedObject.)
	NeedsUpgrade	Gets or sets a Boolean value that specifies whether the object needs to be upgraded. (Inherited from SPPersistedUpgradableObject.)
	NeedsUpgradeIncludeChildren	Gets a Boolean value that indicates whether the object should be upgraded, considering the children of the object. (Inherited from SPPersistedUpgradableObject.)
	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.)
	Required	Gets a Boolean value that indicates whether an instance of the service must be running on at least one computer in the server farm. (Inherited from SPService.)
	RunningJobs	Gets a collection of running jobs for this service. (Inherited from SPService.)
	ShouldDeferUpgradeActions	(Inherited from SPPersistedUpgradableObject.)
	Status	Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.)
	SystemService	(Inherited from SPService.)
	TypeName	A user-friendly name used to describe the object type in the admin UI. (Overrides SPPersistedObject.TypeName.)
	UpgradeContext	Gets the SPUpgradeContext for the current upgrade operation. (Inherited from SPPersistedUpgradableObject.)
	UpgradedPersistedProperties	Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.)
	UsageLogCutTime	The time interval in minutes that Usage log files should use.
	UsageLogDir	The directory for storing usage log files.
	UsageLogMaxFileSize	The file size that Usage log files should be cut and start a new one. Measured in byte.
	UsageLogMaxSpaceGB	The maximum amount of space (measured in gigabytes) allowed for usage logs.
	UsageManager	Provides access to settings of the usage logging system.
	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.)
	Delete	Removes the service and associated resources. (Inherited from SPService.)
	EnsureApplication	Ensures that a valid usage application exists in this farm.
	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.)
	GetCreateApplicationLink	Gets the administration user interface link that is used to create a new service application. (Inherited from SPService.)
	GetCreateApplicationOptions	Gets the options for creating a new service application. (Inherited from SPService.)
	GetFirstPreconfiguredDatabase	(Inherited from SPService.)
	GetHashCode	Serves as a hash function for the persisted object. (Inherited from SPPersistedObject.)
	GetObjectData	Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.)
	GetPreconfiguredDatabaseInfo	(Inherited from SPService.)
	GetType	(Inherited from Object.)
	HasAdditionalUpdateAccess	Override this method to allow more users to update the object. (Inherited from SPPersistedObject.)
	Invalidate	Invalidates computed property values. (Inherited from SPPersistedUpgradableObject.)
	IsLoggingEnabled	Indicates whether logging is enabled for the specified usage application or not.
	IsUserLicensedForEntity	Checks if the current user has the proper license to access the specified entity. (Inherited from SPService.)
	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.)
	Provision	Makes the necessary changes to the local server to use this 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	Unprovisions service from this farm. (Overrides SPPersistedObject.Unprovision().)
	Update()	Causes the object to save its state and propagate changes to all the computers in the server farm. (Inherited from SPPersistedObject.)
	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.)
	Upgrade()	Upgrades the object. (Inherited from SPPersistedUpgradableObject.)
	Upgrade(Boolean)	Upgrades the object, and if a Boolean parameter equals true, recursively upgrades all descendants of the current object. (Inherited from SPPersistedUpgradableObject.)
	Validate	Validates the state of all fields before persisting the object. (Inherited from SPPersistedObject.)
	ValidateBackwardsCompatibility	Validates the backward compatibility of the content database schema for the DLLs on the Web front end. This method is called each time a connection is made to the content database to verify that the database schema is compatible. (Inherited from SPPersistedUpgradableObject.)

Top

Explicit interface implementations

	Name	Description
	IServiceAdministration.CreateApplication	Creates a new usage application or returns an existing application of the given name if it already exists.
	IServiceAdministration.CreateProxy	If no proxy exists for the usage application this method creates one.
	IServiceAdministration.GetApplicationTypeDescription	Retrieves the usage application persisted type description.
	IServiceAdministration.GetApplicationTypes	Gets the application types associated with the SPUsageService.
	IServiceAdministration.GetCreateApplicationLink	This method is not implemented and returns a null reference (Nothing in Visual Basic) or throws a system [NotSupportedException] exception if the given type is not a usage application type.
	IServiceAdministration.GetCreateApplicationOptions	Retrieves the [this.SPCreateApplicationOptions.Default] value.
	IServiceStaticDeployment.CreateStaticApplication

Top

See also

Reference

SPUsageService class

Microsoft.SharePoint.Administration namespace