UsageAnalyticsJobDefinition members
Handles analysis for usage analytics, which is an analysis of how users interact with search results.
The UsageAnalyticsJobDefinition type exposes the following members.
Constructors
Name | Description | |
---|---|---|
![]() |
UsageAnalyticsJobDefinition | Creates an instance of UsageAnalyticsJobDefinition. This constructor is required for deserialization and is used for recreating a SPPersistedObject object based on data that already exists. |
Top
Properties
Name | Description | |
---|---|---|
![]() |
CanRenameOnRestore | (Inherited from SPJobDefinition.) |
![]() |
CanSelectForBackup | (Inherited from SPJobDefinition.) |
![]() |
CanSelectForRestore | (Inherited from SPJobDefinition.) |
![]() |
Description | Gets the localized description of the job definition as a String. (Overrides SPJobDefinition.Description.) |
![]() |
DiskSizeRequired | (Inherited from SPJobDefinition.) |
![]() |
DisplayName | Gets the localized name of the analysis job definition as a String. (Overrides SPJobDefinition.DisplayName.) |
![]() |
EnableBackup | (Inherited from SPJobDefinition.) |
![]() |
Farm | (Inherited from SPPersistedObject.) |
![]() |
HistoryEntries | (Inherited from SPJobDefinition.) |
![]() |
Id | (Inherited from SPPersistedObject.) |
![]() |
IsDisabled | (Inherited from SPJobDefinition.) |
![]() |
LastRunTime | (Inherited from SPJobDefinition.) |
![]() |
LockType | (Inherited from SPJobDefinition.) |
![]() |
Name | (Inherited from SPPersistedObject.) |
![]() |
Parent | (Inherited from SPPersistedObject.) |
![]() |
Properties | (Inherited from SPPersistedObject.) |
![]() |
RecommendationsSecurityTrimmingEnabled | Controls security trimming of the recommendedfor queries. |
![]() |
Retry | (Inherited from SPJobDefinition.) |
![]() |
Schedule | (Inherited from SPJobDefinition.) |
![]() |
Server | (Inherited from SPJobDefinition.) |
![]() |
Service | (Inherited from SPJobDefinition.) |
![]() |
Status | (Inherited from SPPersistedObject.) |
![]() |
Title | (Inherited from SPJobDefinition.) |
![]() |
TypeName | (Inherited from SPPersistedObject.) |
![]() |
UpdateRelationShipCacheThreshold | Gets or sets an integer value that specifies the number of days to aggregate raw usage events used when updating recommendations, which is the output produced by usage analytics. |
![]() |
UpgradedPersistedProperties | (Inherited from SPAutoSerializingObject.) |
![]() |
VerboseTracingEnabled | (Inherited from SPJobDefinition.) |
![]() |
Version | (Inherited from SPPersistedObject.) |
![]() |
WasCreated | (Inherited from SPPersistedObject.) |
![]() |
WebApplication | (Inherited from SPJobDefinition.) |
Top
Methods
Name | Description | |
---|---|---|
![]() |
AddBackupObjects | (Inherited from SPJobDefinition.) |
![]() |
ClearAnalysis | Clears the analysis cache, which must be in the stopped or failed state before its cache can be cleared. |
![]() |
Clone | (Inherited from SPPersistedObject.) |
![]() |
Delete | (Inherited from SPJobDefinition.) |
![]() |
DisableTimerjobSchedule | Disables the timer job from being scheduled. |
![]() |
EnableTimerjobSchedule | Enables the timer job for scheduling. |
![]() |
Equals | (Inherited from SPPersistedObject.) |
![]() |
Execute | Performs analysis lifecycle tasks. Attempts to start the usage analysis when it is time to do so. (Overrides SPJobDefinition.Execute(Guid).) |
![]() |
Finalize | (Inherited from Object.) |
![]() |
GetAnalysisConfiguration | Gets the configuration settings for the current analysis job. |
![]() |
GetAnalysisInfo | Gets analysis information for the current analysis. |
![]() |
GetChild<T>() | (Inherited from SPPersistedObject.) |
![]() |
GetChild<T>(String) | (Inherited from SPPersistedObject.) |
![]() |
GetHashCode | (Inherited from SPPersistedObject.) |
![]() |
GetObjectData | (Inherited from SPAutoSerializingObject.) |
![]() |
GetType | (Inherited from Object.) |
![]() |
HasAdditionalUpdateAccess | (Inherited from SPPersistedObject.) |
![]() |
MemberwiseClone | (Inherited from Object.) |
![]() |
OnAbort | (Inherited from SPJobDefinition.) |
![]() |
OnBackup | (Inherited from SPJobDefinition.) |
![]() |
OnBackupComplete | (Inherited from SPJobDefinition.) |
![]() |
OnDeserialization | (Inherited from SPPersistedObject.) |
![]() |
OnPostRestore | (Inherited from SPJobDefinition.) |
![]() |
OnPrepareBackup | (Inherited from SPJobDefinition.) |
![]() |
OnPreRestore | (Inherited from SPJobDefinition.) |
![]() |
OnRestore | (Inherited from SPJobDefinition.) |
![]() |
Provision | (Inherited from SPPersistedObject.) |
![]() |
RefreshAnalysisConfiguration | Refreshes the configuration settings for the current analysis by reloading the configuration settings from where it was stored previously. |
![]() |
ResumeAnalysis | Resumes the analysis which must in the paused state. |
![]() |
RunNow | (Inherited from SPJobDefinition.) |
![]() |
SetDailyAnalysisScheduleHour | Sets the hour component of the daily time schedule for usage analytics. Valid values are between 0 and 23. |
![]() |
SetDayOffset | Sets an offset (in hours) from local time that specifies the start of the day. Valid values are between -23 and 23. |
![]() |
SetRefeedToSearchIndexOnNextRun | Set this parameter to indicate that the RefeedFromCache flag should be set before the next analysis job run. |
![]() |
StartAnalysis() | Starts the analysis if it is either in the stopped or the failed state. |
![]() |
StartAnalysis(String) | Starts the analysis if it is not running already. |
![]() |
StopAnalysis | Stops the analysis, which must be in the running or the paused state. |
![]() |
SuspendAnalysis | Suspends the analysis, which must be in the running state. |
![]() |
ToString | (Inherited from SPPersistedObject.) |
![]() |
Uncache | (Inherited from SPPersistedObject.) |
![]() |
Unprovision | (Inherited from SPPersistedObject.) |
![]() |
Update() | (Inherited from SPJobDefinition.) |
![]() |
Update(Boolean) | (Inherited from SPPersistedObject.) |
![]() |
UpdateParent | (Inherited from SPAutoSerializingObject.) |
![]() |
UpdateProgress | (Inherited from SPJobDefinition.) |
![]() |
Validate | (Inherited from SPJobDefinition.) |
Top