SearchAnalyticsJobBase members
Base class for analysis jobs. This base class includes some additional implementations related to AnalyticsJobBase.
The SearchAnalyticsJobBase type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Protected method") |
SearchAnalyticsJobBase() | Creates an instance of a class that inherits from SearchAnalyticsJobBase. This constructor is required for deserialization and used for re-creating a SPPersistedObject object based on data that already exists. |
|
SearchAnalyticsJobBase(Guid, String, SPPersistedObject) | Creates an instance of a class that inherits from SearchAnalyticsJobBase. This constructor is used to create the initial class instance, creating a new SPPersistedObject instance. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Protected property") |
CompletedRuns | Gets or sets a Int64 value that keeps track of the view this analytics job has, of completed analysis runs. This property indicates if a new analysis is complete. (Inherited from AnalyticsJobBase.) |
|
CurrentRunTime | Gets or sets a DateTime value, holding the start time of the current run in progress. When the run is completed, this value will replace LastRunTime. |
|
DbIsAvailable | Gets or sets a Boolean value denoting if the Link database is available or not. |
.gif "Public property") |
Description | Gets the localized description of the analysis job definition as a String (Inherited from AnalyticsJobBase.) |
|
DisplayName | (Inherited from SPPersistedObject.) |
|
Farm | (Inherited from SPPersistedObject.) |
|
GetNextRunStartTime | Gets the time for when the next analysis job is scheduled to run. (Inherited from AnalyticsJobBase.) |
|
Id | (Inherited from SPPersistedObject.) |
|
IsDirty | Gets or sets a Boolean that indicates if the state of the timer job object has changed. (Inherited from AnalyticsJobBase.) |
|
JobScheduleDisabled | Gets or sets a Boolean value to enable or disable analysis job scheduling. (Inherited from AnalyticsJobBase.) |
|
LastRunTime | Gets or sets a DateTime value, holding the start time of last analysis job run that was successful. |
|
LastSuccessfulAnalysisRun | Gets or sets a DateTime value, holding the timestamp of the last analysis job that was completed successfully. |
|
LocalUlsLogSourceName | Gets or sets a String value to be used in ULS events. |
|
Name | (Inherited from SPPersistedObject.) |
|
NextScheduledRun | Gets or sets a DateTime value, holding the time of next analysis run scheduled. (Overrides AnalyticsJobBase.NextScheduledRun.) |
|
NumFailed | Gets or sets an integer value, holding the number of analyses that have failed repeatedly. |
|
Parent | (Inherited from SPPersistedObject.) |
|
Properties | (Inherited from SPPersistedObject.) |
|
Status | (Inherited from SPPersistedObject.) |
|
TypeName | (Inherited from SPPersistedObject.) |
|
UlsPrefix | Gets a String value used to prefix ULS log messages. (Inherited from AnalyticsJobBase.) |
|
UpgradedPersistedProperties | (Inherited from SPAutoSerializingObject.) |
|
Version | (Inherited from SPPersistedObject.) |
|
WasCreated | (Inherited from SPPersistedObject.) |
Top
Methods
| Name | Description | |
|---|---|---|
|
CheckLinkDbConnections | Checks the availability of partitions in the Link database. |
.gif "Public method") |
ClearAnalysis | Clears the analysis cache, which must be in the stopped or failed state before its cache can be cleared. (Inherited from AnalyticsJobBase.) |
|
Clone | (Inherited from SPPersistedObject.) |
|
CompletedRunsIsIncremented | Checks if the analysis job has completed a new run. (Inherited from AnalyticsJobBase.) |
|
Delete | (Inherited from SPPersistedObject.) |
|
DisableJobSchedule | Disables scheduling of the current job. (Inherited from AnalyticsJobBase.) |
|
EnableJobSchedule | Enables scheduling of the current analysis job. (Inherited from AnalyticsJobBase.) |
|
Equals | (Inherited from SPPersistedObject.) |
|
ExecuteInternal(IAnalysisEngineAgent) | Called regularly by an instance of AnalyticsJobDefinition, which represents the general timer job for SearchAnalyticsJob and SearchReportsJob. (Inherited from AnalyticsJobBase.) |
|
ExecuteInternal(IAnalysisEngineAgent, Boolean) | Implementation of this method should contain analysis lifecycle tasks. One of these tasks should be an attempt to start analysis if it is time to do so. The latter should require that startAnalysis is set to true. |
|
Finalize | (Inherited from Object.) |
|
GetAnalysisConfiguration | Gets the configuration settings for the current analysis. (Inherited from AnalyticsJobBase.) |
|
GetAnalysisInfo | Gets analysis information for the current analysis. (Inherited from AnalyticsJobBase.) |
|
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.) |
|
OnDeserialization | (Inherited from SPPersistedObject.) |
|
Provision | (Inherited from SPPersistedObject.) |
|
RefreshAnalysisConfiguration | Refreshes the configuration settings for the current analysis by reloading the settings from the internal location where they are stored. (Inherited from AnalyticsJobBase.) |
|
ResumeAnalysis | Resumes the analysis job, which must be in a paused state. (Inherited from AnalyticsJobBase.) |
|
SaveStateIfChanged | Saves the state to the configuration database if the state has changed since the last check. (Inherited from AnalyticsJobBase.) |
|
SetValue<T> | Use when asserting a new value to certain properties to ensure state changes that need to be written to the database are tracked. (Inherited from AnalyticsJobBase.) |
|
StartAnalysis | Starts the analysis, which must be in the stopped or failed state before it can be started. (Overrides AnalyticsJobBase.StartAnalysis().) |
|
StopAnalysis | Stops the analysis, which must be in the running or paused state. (Inherited from AnalyticsJobBase.) |
|
SuspendAnalysis | Suspends the analysis, which must be in the running state. (Inherited from AnalyticsJobBase.) |
|
ToString | (Inherited from SPPersistedObject.) |
|
Uncache | (Inherited from SPPersistedObject.) |
|
Unprovision | (Inherited from SPPersistedObject.) |
|
Update() | (Inherited from SPPersistedObject.) |
|
Update(Boolean) | (Inherited from SPPersistedObject.) |
|
UpdateNextScheduledRun | Sets the next time to run a new analysis job. |
|
UpdateParent | (Inherited from SPAutoSerializingObject.) |
|
Validate | (Inherited from SPPersistedObject.) |
Top
Fields
| Name | Description | |
|---|---|---|
.gif "Protected field") .gif "Static member") |
MaxTimespanWithUnsuccessfulAnalysis | Maximum number of hours before a critical message is logged to indicate that no successful analysis job runs have occurred. |
Top