Table of Contents

Class ExecutionHistoryStep

Namespace
ArcanaDevelopment.adTempus.Client
Assembly
ArcanaDevelopment.adTempus.Client.dll
public sealed class ExecutionHistoryStep : ADTObject
Inheritance
object
ExecutionHistoryStep

Properties

CID

The Class ID for the object

[IgnoreDataMember]
public override ClassID CID { get; }

Property Value

ClassID

Remarks

Obsolete. Use ClassID instead.

CapturedFiles

public CapturedFileCollection CapturedFiles { get; }

Property Value

CapturedFileCollection

Checkpoint

The last Checkpoint reported for the step.

public string Checkpoint { get; }

Property Value

string

ClassKeyName

The key name for the class.

public override string ClassKeyName { get; }

Property Value

string

Remarks

This name the name used by adTempus to identify the class and is intended for programmatic use only. Use the ClassName for a user-friendly name.

ConditionStatuses

public ConditionStatusCollection ConditionStatuses { get; }

Property Value

ConditionStatusCollection

ElapsedTime

Time elapsed between ExecutionStart and ExecutionFinish, or between ExecutionStart and current time if step is still active.

public TimeSpan? ElapsedTime { get; }

Property Value

TimeSpan?

ExecutionFinish

[ComVisible(false)]
public DateTimeOffset? ExecutionFinish { get; }

Property Value

DateTimeOffset?

ExecutionStart

[ComVisible(false)]
public DateTimeOffset? ExecutionStart { get; }

Property Value

DateTimeOffset?

ExitCode

Gets the exit code/result for the step.

public string ExitCode { get; }

Property Value

string

Remarks

The ExitCode can be a numeric exit code or a string result. The value is limited to 255 characters and will be truncated if it exceeds that length.

<xref href="ArcanaDevelopment.adTempus.Client.ExecutionHistoryStep.Result" data-throw-if-not-resolved="false"></xref> returns the same value.

IsDependent

[IgnoreDataMember]
public override bool IsDependent { get; }

Property Value

bool

KernelModeTime

public int KernelModeTime { get; }

Property Value

int

MemoryUsage

The peak working set size for the process, in KB.

public int MemoryUsage { get; }

Property Value

int

ProcessID

public int ProcessID { get; }

Property Value

int

RestartCount

public int RestartCount { get; }

Property Value

int

Result

Gets the result returned by the task.

public object Result { get; }

Property Value

object

Remarks

Same as ExitCode.

Status

public JobState Status { get; }

Property Value

JobState

StatusDescription

Gets the text description of the Status.

public string StatusDescription { get; }

Property Value

string

StepDescription

public string StepDescription { get; }

Property Value

string

StepNumber

public int StepNumber { get; }

Property Value

int

StepOID

public OID StepOID { get; }

Property Value

OID

UserModeTime

public int UserModeTime { get; }

Property Value

int

Methods

FindOwningObject()

Get the owner of this object based on relationships.

protected override ADTObject FindOwningObject()

Returns

ADTObject

The owning object, or null if the object is not owned by another object or the owner has not been set.

GetObjectDescription()

Gets a description of the object's key settings.

protected override string GetObjectDescription()

Returns

string

Remarks

This method is called by GetDescription() to get a user-friendly description of the object (such as its key settings) for display to the user. The description should contain enough information to distinguish this object from others of the same class.

See Also

GetStep()

Gets the JobStep to which this item belongs.

public JobStep GetStep()

Returns

JobStep

Remarks

The JobStep may be null if the job has been deleted from the server (execution history may not be deleted at the same time the job is deleted).

WriteToConfigurationReport(IADTObjectConfigurationReportWriter)

public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)

Parameters

NameTypeDescription
reportBuilder IADTObjectConfigurationReportWriter

Inherited Members