Class JobStatusEntity

The job status entity.

Inheritance

object

JobStatusEntity

SQLiteStorageJobStatusEntity

Implements

ICloneable

IJobStatusEntity

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: DNVGL.One.Compute.StorageLibrary.Entities

Assembly: DNVGL.One.Compute.StorageLibrary.dll

Syntax

public class JobStatusEntity : ICloneable, IJobStatusEntity

Constructors

View Source

JobStatusEntity()

Initializes a new instance of the JobStatusEntity class.

Declaration

public JobStatusEntity()

View Source

JobStatusEntity(Job)

Initializes a new instance of the JobStatusEntity class.

Declaration

public JobStatusEntity(Job job)

Parameters

Type	Name	Description
Job	job	The job.

Properties

View Source

ClientReference

Gets or sets the client job reference. This is reserved for use by the client for referencing purposes and will not be used by OneCompute.

Declaration

public string ClientReference { get; set; }

Property Value

Type	Description
string	The client job reference.

View Source

CompletionTime

Gets or sets the completion time.

Declaration

public DateTime CompletionTime { get; set; }

Property Value

Type	Description
DateTime	The completion time (in UTC).

Remarks

Backing field introduced to ensure time is returned in UTC. This was necessary because SQLite's string handling of DateTime seems to convert UTC into local time. NOTICE: This property is set every time the job status is updated, so its use has been extended beyond its original intention. Now it really reflects the time of last update, which is equivalent to CompletionTime once the State is terminal.

View Source

EnvironmentId

Gets or sets the id of the environment the job executed in.

Declaration

public string EnvironmentId { get; set; }

Property Value

Type	Description
string	The id of the environment the job executed in.

View Source

JobId

Gets or sets the job identifier.

Declaration

public string JobId { get; set; }

Property Value

Type	Description
string

View Source

JobName

Gets or sets the name of the job. This is reserved for use by the client for description purposes and will not be used by OneCompute.

Declaration

public string JobName { get; set; }

Property Value

Type	Description
string	The name of the job.

View Source

Message

Gets or sets the message for the job.

Declaration

public string Message { get; set; }

Property Value

Type	Description
string	The message.

View Source

PoolId

Gets or sets the pool identifier.

Declaration

public string PoolId { get; set; }

Property Value

Type	Description
string

View Source

Progress

Gets or sets progress.

Declaration

public double Progress { get; set; }

Property Value

Type	Description
double

Remarks

Progress is defined as a fraction of 1, where 0 = no progress and 1 = complete.

View Source

ServiceName

Gets or sets the name of the service.

Declaration

public string ServiceName { get; set; }

Property Value

Type	Description
string	The name of the service.

View Source

StartTime

Gets or sets the start time.

Declaration

public DateTime StartTime { get; set; }

Property Value

Type	Description
DateTime	The start time (in UTC).

Remarks

Backing field introduced to ensure time is returned in UTC. This was necessary because SQLite's string handling of DateTime seems to convert UTC into local time.

View Source

State

Gets or sets State.

Declaration

public int State { get; set; }

Property Value

Type	Description
int

View Source

TotalComputeSeconds

Gets or sets the accumulated compute time in seconds.

Declaration

public long TotalComputeSeconds { get; set; }

Property Value

Type	Description
long	The accumulated compute time in seconds.

View Source

UserId

Gets or sets the user identifier.

Declaration

public string UserId { get; set; }

Property Value

Type	Description
string

Methods

View Source

Clone()

Returns memberwise clone.

Declaration

public virtual object Clone()

Returns

Type	Description
object	Cloned object/>.

View Source

UpdateState(WorkStatus)

Update the job state.

Declaration

public void UpdateState(WorkStatus state)

Parameters

Type	Name	Description
WorkStatus	state	The state.

Implements

ICloneable

IJobStatusEntity