JobState Class

 Structured Analytics API Documentation
Represents general information about the current state of a structured analytics set and its analysis.
Inheritance Hierarchy
System.Object
  Relativity.StructuredAnalytics.Services.Interfaces.StructuredAnalytics.Models.Status.JobState

Namespace:  Relativity.StructuredAnalytics.Services.Interfaces.StructuredAnalytics.Models.Status
Assembly:  Relativity.Threads.Services.Interfaces (in Relativity.Threads.Services.Interfaces.dll) Version: 10.0.0.0 (10.0.0.0)
Syntax
Copy
public class JobState

The JobState type exposes the following members.

Constructors
  NameDescription
Public methodJobState
Initializes a new instance of the JobState class
Top
Properties
  NameDescription
Public propertyIsCanceled
Indicates whether an analysis has been canceled.
Public propertyIsCanceling
Indicates whether an analysis is currently canceling.
Public propertyIsCompleted
Indicates whether an analysis has completed running.
Public propertyIsQueued
Indicates whether an analysis has been queued behind another running analysis.
Public propertyIsRunning
Indicates whether an analysis is currently running.
Public propertyIsRunningOperations
Indicates whether an analysis is currently running operations.
Public propertyIsUnknown
Indicates whether the current state is unknown
Public propertyJobTimeElapsed
Gets the number of seconds since the analysis has started.
Public propertyOperationTimeElapsed
Gets the number of seconds since the current operation has started.
Public propertyPhase
Gets the current phase of an analysis.
Public propertyPhaseProgressPercentage
Gets the progress of the current phase as a percentage.
Public propertyStatus
Gets the status value.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Top
See Also

Reference

Relativity.StructuredAnalytics.Services.Interfaces.StructuredAnalytics.Models.Status Namespace