Table of Contents

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

AllStatuses

List of all JobState values .

public static readonly JobState[] AllStatuses

Field Value

JobState[]

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

Properties

ActiveStatuses

List of the JobState values that indicate an active instance

public static JobState[] ActiveStatuses { get; }

Property Value

JobState[]

Remarks

The following JobState values are included:

  • JobState.Starting
  • JobState.Running
  • JobState.Killing
  • JobState.Aborting
  • JobState.WaitingForCondition
  • JobState.WaitingForResource
  • JobState.Queued
  • JobState.AgentQueued
  • JobState.AgentDispatched
See Also

FailureStatuses

List of the JobState values that indicate a failure status.

public static JobState[] FailureStatuses { get; }

Property Value

JobState[]

Remarks

The following JobState values are included:

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

FinalStatuses

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

public static JobState[] FinalStatuses { get; }

Property 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 { get; }

Property Value

JobState[]

Remarks

The following JobState values are included:

  • JobState.Queued
  • JobState.WaitingForPreviousInstance

NotRunStatuses

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

public static JobState[] NotRunStatuses { get; }

Property 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.WaitingForPreviousInstance
  • JobState.WaitingForResource
  • JobState.WaitingForRestart
  • JobState.WaitingForTrigger
See Also

QueuedStatuses

List of the JobState values that indicate a queued status.

public static JobState[] QueuedStatuses { get; }

Property Value

JobState[]

Remarks

The following JobState values are included:

  • JobState.Queued
  • JobState.AgentQueued
  • JobState.WaitingForPreviousInstance

SuccessStatuses

List of the JobState values that indicate a success status.

public static JobState[] SuccessStatuses { get; }

Property 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 JobState[] WaitingStatuses { get; }

Property Value

JobState[]

Remarks

The following JobState values are included:

  • JobState.WaitingForCondition
  • JobState.WaitingForResource
  • JobState.WaitingForPreviousInstance
  • JobState.WaitingForRestart
  • JobState.Queued
  • JobState.AgentQueued
See Also

WarningStatuses

List of the JobState values that indicate a warning status.

public static JobState[] WarningStatuses { get; }

Property 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

NameTypeDescription
status JobState

Returns

string

IsFailure(JobState)

Indicates whether a status represents a failure state

public static bool IsFailure(JobState status)

Parameters

NameTypeDescription
status JobState

Returns

bool
See Also

IsFinal(JobState)

Indicates whether a status represents a final state

public static bool IsFinal(JobState status)

Parameters

NameTypeDescription
status JobState

Returns

bool
See Also

IsQueued(JobState)

Indicates whether a status represents a queued state

public static bool IsQueued(JobState status)

Parameters

NameTypeDescription
status JobState

Returns

bool
See Also

IsRunning(JobState)

Indicates whether a status represents a running state

public static bool IsRunning(JobState status)

Parameters

NameTypeDescription
status JobState

Returns

bool
See Also

IsSuccess(JobState)

Indicates whether a status represents a success state

public static bool IsSuccess(JobState status)

Parameters

NameTypeDescription
status JobState

Returns

bool
See Also

IsWaiting(JobState)

Indicates whether a status represents a waiting state

public static bool IsWaiting(JobState status)

Parameters

NameTypeDescription
status JobState

Returns

bool
See Also

IsWarning(JobState)

Indicates whether a status represents a warning state

public static bool IsWarning(JobState status)

Parameters

NameTypeDescription
status JobState

Returns

bool
See Also