AnalyticsIndexStatus Class

Analytics Core API Documentation
The public representation of the aggregate state of an Analytics Index RDO.
Inheritance Hierarchy

SystemObject
  Analytics.Conceptual.DataContractsAnalyticsIndexStatus

Namespace:  Analytics.Conceptual.DataContracts
Assembly:  Analytics.Conceptual.DataContracts (in Analytics.Conceptual.DataContracts.dll) Version: 10.1.2.93
Syntax

public class AnalyticsIndexStatus

The AnalyticsIndexStatus type exposes the following members.

Properties

  NameDescription
Public propertyActive
Indicates if the index is active and able to be queried.
Public propertyConsoleButtons
List of console buttons and links with their current states.
Public propertyCurrentStep
The current job step, if a multi step job is in progress.
Public propertyDocLevelErrorsExist
Indicates if there are documents in error in the training set.
Public propertyLastErrorMessage
The last error that occured on this index
Public propertyOverallTimeElapsed
The total time of the current job, if there is one.
Public propertyPercentageComplete
The completed percentage of the current job step, if it has one.
Public propertyPercentDenominator
The denominator value to generate the percentage of the current job step, if there is one.
Public propertyPercentNumerator
The numerator value to generate the percentage of the current job step, if there is one.
Public propertySearchableSetCount
The count of items in the searchable set if the index is new or active in its final state.
Public propertySecondaryPercentageComplete
The completed percentage of a stage of a job step, if it has one.
Public propertySecondaryStatusText
Ancillary status text.
Public propertyStatusText
The main status text of the index.
Public propertyStepTimeElapsed
The elapsed time of the current job step, if there is one.
Public propertyTotalSteps
The total number of job steps, if a multi step job is in progress.
Public propertyTrainingSetCount
The count of items in the training set if the index is new or active in its final state.
Top
See Also

Reference