Class JobStatusHelpers

Namespace

ArcanaDevelopment.adTempus.Shared

Assembly

ArcanaDevelopment.adTempus.Shared.dll

Providers helpers for classifying and describing JobState values.

public static class JobStatusHelpers

Inheritance

object

JobStatusHelpers

Fields

ActiveStatuses

List of the JobState values that indicate an active instance

public static readonly JobState[] ActiveStatuses

Field Value

JobState[]

Remarks

The following JobState values are included:

• JobState.Aborting
• JobState.AgentDispatched
• JobState.AgentQueued
• JobState.Killing
• JobState.Queued
• JobState.Running
• JobState.Starting
• JobState.WaitingForCondition
• JobState.WaitingForDelay
• JobState.WaitingForExclusionPeriod
• JobState.WaitingForResource

See Also

WaitingStatuses

AllStatuses

List of all JobState values .

public static readonly JobState[] AllStatuses

Field Value

JobState[]

AllStatusesV4

List of the JobState values that are valid for adTempus 4.

public static readonly JobState[] AllStatusesV4

Field Value

JobState[]

ConditionRunningStatuses

States that are considered when a Job Condition is looking for "running" or "not running" instances (any instance with one of these states is "running").

public static readonly JobState[] ConditionRunningStatuses

Field Value

JobState[]

DelayedExecutionStatuses

List of the JobState values that indicate an instance that is waiting for delayed execution

public static JobState[] DelayedExecutionStatuses

Field Value

JobState[]

Remarks

The following JobState values are included:

• JobState.WaitingForDelay
• JobState.WaitingForExclusionPeriod

FailureStatuses

List of the JobState values that indicate a failure status.

public static readonly JobState[] FailureStatuses

Field Value

JobState[]

Remarks

The following JobState values are included:

• JobState.ConditionFailed
• JobState.CompletedWithErrors
• JobState.ExecutionFailed
• JobState.Failed
• JobState.Killed
• JobState.ResourceFailed
• JobState.TriggerFailed

FinalStatuses

List of the JobState values that indicate a the final status of an instance or step.

public static readonly JobState[] FinalStatuses

Field Value

JobState[]

Remarks

The following JobState values are included:

• JobState.Abandoned
• JobState.Aborted
• JobState.CompletedWithWarnings
• JobState.ConditionFailed
• JobState.ConditionNotMet
• JobState.ExecutionFailed
• JobState.Failed
• JobState.Killed
• JobState.ResourceFailed
• JobState.Resubmitted
• JobState.Skipped
• JobState.Succeeded

LocalQueuedStatuses

List of the JobState values that indicate an instance that is queued locally.

public static JobState[] LocalQueuedStatuses

Field Value

JobState[]

Remarks

The following JobState values are included:

• JobState.Queued
• JobState.WaitingForPreviousInstance

NotExecutedStatuses

List of the JobState values that indicate an instance or step that was not submitted for execution.

public static readonly JobState[] NotExecutedStatuses

Field Value

JobState[]

See Also

NotRunStatuses

NotRunStatuses

List of the JobState values that indicate an instance or step that was not run or did not complete

public static readonly JobState[] NotRunStatuses

Field Value

JobState[]

Remarks

The following JobState values are included:

• JobState.AgentDispatched
• JobState.AgentQueued
• JobState.ConditionFailed
• JobState.ConditionNotMet
• JobState.Missed
• JobState.NotRun
• JobState.Skipped
• JobState.Queued
• JobState.ResourceFailed
• JobState.Skipped
• JobState.Unknown
• JobState.WaitingForCondition
• JobState.WaitingForDelay
• JobState.WaitingForExclusionPeriod
• JobState.WaitingForPreviousInstance
• JobState.WaitingForResource
• JobState.WaitingForRestart
• JobState.WaitingForTrigger

See Also

NotExecutedStatuses

QueuedStatuses

List of the JobState values that indicate a queued status.

public static readonly JobState[] QueuedStatuses

Field Value

JobState[]

Remarks

The following JobState values are included:

• JobState.Queued
• JobState.AgentQueued
• JobState.WaitingForDelay
• JobState.WaitingForExclusionPeriod
• JobState.WaitingForPreviousInstance

SuccessStatuses

List of the JobState values that indicate a success status.

public static readonly JobState[] SuccessStatuses

Field Value

JobState[]

Remarks

The following JobState values are included:

• JobState.Success

WaitingStatuses

List of the JobState values that indicate an instance that is waiting for something

public static readonly JobState[] WaitingStatuses

Field Value

JobState[]

Remarks

The following JobState values are included:

• JobState.AgentQueued
• JobState.Queued
• JobState.WaitingForCondition
• JobState.WaitingForDelay
• JobState.WaitingForExclusionPeriod
• JobState.WaitingForPreviousInstance
• JobState.WaitingForResource
• JobState.WaitingForRestart

See Also

ActiveStatuses

WarningStatuses

List of the JobState values that indicate a warning status.

public static readonly JobState[] WarningStatuses

Field Value

JobState[]

Remarks

The following JobState values are included:

• JobState.Abandoned
• JobState.Aborted
• JobState.CompletedWithErrors
• JobState.CompletedWithWarnings

Methods

GetJobStatusDescription(JobState)

Gets a descriptive label for a job state.

public static string GetJobStatusDescription(JobState status)

Parameters

Name	Type	Description
status	JobState	The status to evaluate

Returns

string

IsDelayed(JobState)

Indicates whether a status represents a delayed state

public static bool IsDelayed(JobState status)

Parameters

Name	Type	Description
status	JobState	The status to evaluate

Returns

bool

See Also

DelayedExecutionStatuses

IsFailure(JobState)

Indicates whether a status represents a failure state

public static bool IsFailure(JobState status)

Parameters

Name	Type	Description
status	JobState	The status to evaluate

Returns

bool

See Also

FailureStatuses

IsFinal(JobState)

Indicates whether a status represents a final state

public static bool IsFinal(JobState status)

Parameters

Name	Type	Description
status	JobState	The status to evaluate

Returns

bool

See Also

FinalStatuses

IsQueued(JobState)

Indicates whether a status represents a queued state

public static bool IsQueued(JobState status)

Parameters

Name	Type	Description
status	JobState	The status to evaluate

Returns

bool

See Also

QueuedStatuses

IsRunning(JobState)

Indicates whether a status represents a running state

public static bool IsRunning(JobState status)

Parameters

Name	Type	Description
status	JobState	The status to evaluate

Returns

bool

See Also

ActiveStatuses

IsSuccess(JobState)

Indicates whether a status represents a success state

public static bool IsSuccess(JobState status)

Parameters

Name	Type	Description
status	JobState	The status to evaluate

Returns

bool

See Also

SuccessStatuses

IsWaiting(JobState)

Indicates whether a status represents a waiting state

public static bool IsWaiting(JobState status)

Parameters

Name	Type	Description
status	JobState	The status to evaluate

Returns

bool

See Also

WaitingStatuses

IsWarning(JobState)

Indicates whether a status represents a warning state

public static bool IsWarning(JobState status)

Parameters

Name	Type	Description
status	JobState	The status to evaluate

Returns

bool

See Also

WarningStatuses