Class RunStepResult
Holds the result of the execution of a IRunStep.
Namespace: Unity.Build
Syntax
public class RunStepResult : IDisposableProperties
BuildSettings
The BuildSettings used to run this IRunStep.
Declaration
public BuildSettings BuildSettings { get; }Property Value
| Type | Description |
|---|---|
| BuildSettings |
Failed
Determine if the execution of the IRunStep failed.
Declaration
public bool Failed { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
Message
The message resulting from the execution of this IRunStep.
Declaration
public string Message { get; }Property Value
| Type | Description |
|---|---|
| String |
RunInstance
The running process resulting from running the IRunStep.
Declaration
public IRunInstance RunInstance { get; }Property Value
| Type | Description |
|---|---|
| IRunInstance |
RunStep
The IRunStep that was executed.
Declaration
public IRunStep RunStep { get; }Property Value
| Type | Description |
|---|---|
| IRunStep |
Succeeded
Determine if the execution of the IRunStep succeeded.
Declaration
public bool Succeeded { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
Methods
Dispose()
Declaration
public void Dispose()Failure(BuildSettings, IRunStep, String)
Create a new instance of RunStepResult that represent a failed execution.
Declaration
public static RunStepResult Failure(BuildSettings settings, IRunStep step, string message)Parameters
| Type | Name | Description |
|---|---|---|
| BuildSettings | settings | The BuildSettings used by the IRunStep. |
| IRunStep | step | The IRunStep that was executed. |
| String | message | The failure message. |
Returns
| Type | Description |
|---|---|
| RunStepResult | A new RunStepResult instance. |
LogResult()
Declaration
public void LogResult()Success(BuildSettings, IRunStep, IRunInstance)
Create a new instance of RunStepResult that represent a successful execution.
Declaration
public static RunStepResult Success(BuildSettings settings, IRunStep step, IRunInstance instance)Parameters
| Type | Name | Description |
|---|---|---|
| BuildSettings | settings | The BuildSettings used by the IRunStep. |
| IRunStep | step | The IRunStep that was executed. |
| IRunInstance | instance | The IRunInstance resulting from running this IRunStep. |
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 |