Class RunStepResult

Holds the result of the execution of a RunStep.

Inheritance
Object
ResultBase
RunStepResult
Inherited Members
Namespace: Unity.Build
Syntax
public sealed class RunStepResult : ResultBase, IDisposable

Constructors

RunStepResult()

Declaration
public RunStepResult()

Properties

BuildSettings

Declaration
[Obsolete("BuildSettings has been renamed to BuildConfiguration. (RemovedAfter 2020-05-01) (UnityUpgradable) -> BuildConfiguration")]
public BuildConfiguration BuildSettings { get; }
Property Value
Type Description
BuildConfiguration

RunInstance

The running process resulting from running the RunStep.

Declaration
public IRunInstance RunInstance { get; }
Property Value
Type Description
IRunInstance

RunStep

The RunStep that was executed.

Declaration
public RunStep RunStep { get; }
Property Value
Type Description
RunStep

Methods

Dispose()

Declaration
public void Dispose()

Failure(BuildConfiguration, RunStep, Exception)

Create a new instance of RunStepResult that represent a failed execution.

Declaration
public static RunStepResult Failure(BuildConfiguration config, RunStep step, Exception exception)
Parameters
Type Name Description
BuildConfiguration config

The BuildConfiguration used by the RunStep.
RunStep step

The RunStep that was executed.
Exception exception

The exception.
Returns
Type Description
RunStepResult

A new RunStepResult instance.

Failure(BuildConfiguration, RunStep, String)

Create a new instance of RunStepResult that represent a failed execution.

Declaration
public static RunStepResult Failure(BuildConfiguration config, RunStep step, string message)
Parameters
Type Name Description
BuildConfiguration config

The BuildConfiguration used by the RunStep.
RunStep step

The RunStep that was executed.
String message

The failure message.
Returns
Type Description
RunStepResult

A new RunStepResult instance.

Success(BuildConfiguration, RunStep, IRunInstance)

Create a new instance of RunStepResult that represent a successful execution.

Declaration
public static RunStepResult Success(BuildConfiguration config, RunStep step, IRunInstance instance)
Parameters
Type Name Description
BuildConfiguration config

The BuildConfiguration used by the RunStep.
RunStep step

The RunStep that was executed.
IRunInstance instance

The IRunInstance resulting from running this RunStep.
Returns
Type Description
RunStepResult

A new RunStepResult instance.

ToString()

Declaration
public override string ToString()
Returns
Type Description
String
Overrides

Operators

Implicit(RunStepResult to Boolean)

Implicit conversion to Boolean.

Declaration
public static implicit operator bool (RunStepResult result)
Parameters
Type Name Description
RunStepResult result

Instance of RunStepResult.
Returns
Type Description
Boolean