Class SetupStepStatus

Holds state information about a setup step.

Inheritance
object
NotifyPropertyChanged
SetupStepStatus
Inherited Members
Namespace: Neon.Kube.Setup
Assembly: Neon.Kube.dll
Syntax
public class SetupStepStatus : NotifyPropertyChanged

Constructors

SetupStepStatus(int, string, SetupStepState, ISetupControllerStep, TimeSpan)

Constructor.

Declaration
public SetupStepStatus(int stepNumber, string stepLabel, SetupStepState stepState, ISetupControllerStep internalStep, TimeSpan runTime = default)
Parameters
Type Name Description
int stepNumber

The step number or zero for quiet steps.
string stepLabel

The setup step label.
SetupStepState stepState

The current status for the step.
ISetupControllerStep internalStep

Specifies the internal setup controller step.
TimeSpan runTime

Optionally specifies the runtime for completed steps or Zero when the step hasn't completed execution.

Properties

InternalStep

Returns the internal SetupController<NodeMetadata> step.

Declaration
[JsonIgnore]
public ISetupControllerStep InternalStep { get; set; }
Property Value
Type Description
ISetupControllerStep

IsGlobalStep

Returns true for global steps, false for node steps.

Declaration
public bool IsGlobalStep { get; }
Property Value
Type Description
bool

IsQuiet

Returns true for steps that where progress not intended to be reported to the user.

Declaration
public bool IsQuiet { get; set; }
Property Value
Type Description
bool

Label

Returns the step label.

Declaration
public string Label { get; set; }
Property Value
Type Description
string

Number

Returns the step number.

Declaration
public int Number { get; set; }
Property Value
Type Description
int

Runtime

Returns how long the step has been executing for the current step or the total runtime for when the step has completed or failed.

Declaration
public TimeSpan Runtime { get; set; }
Property Value
Type Description
TimeSpan

State

Returns the current step state.

Declaration
public SetupStepState State { get; set; }
Property Value
Type Description
SetupStepState

Methods

Clone()

Returns a clone of a source (not cloned) instance.

Declaration
public SetupStepStatus Clone()
Returns
Type Description
SetupStepStatus

The clone.

UpdateFrom(SetupStepStatus)

Copies the properties from the source status to this instance, raising INotifyPropertyChanged related events as require.

Declaration
public void UpdateFrom(SetupStepStatus source)
Parameters
Type Name Description
SetupStepStatus source

The source instance.