Class BuildPipelineResult
Holds the results of the execution of a BuildPipeline.
Namespace: Unity.Build
Syntax
public class BuildPipelineResultProperties
BuildPipeline
The BuildPipeline that was run.
Declaration
public BuildPipeline BuildPipeline { get; }Property Value
| Type | Description |
|---|---|
| BuildPipeline |
BuildSettings
The BuildSettings used throughout the execution of the BuildPipeline.
Declaration
public BuildSettings BuildSettings { get; }Property Value
| Type | Description |
|---|---|
| BuildSettings |
BuildStepsResults
A list of BuildStepResult collected during the BuildPipeline execution for each IBuildStep.
Declaration
public List<BuildStepResult> BuildStepsResults { get; }Property Value
| Type | Description |
|---|---|
| List<BuildStepResult> |
Duration
The total duration of the BuildPipeline execution.
Declaration
public TimeSpan Duration { get; }Property Value
| Type | Description |
|---|---|
| TimeSpan |
Failed
Determine if the execution of the BuildPipeline failed.
Declaration
public bool Failed { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
Message
The message resulting from the execution of this BuildPipeline.
Declaration
public string Message { get; }Property Value
| Type | Description |
|---|---|
| String |
Succeeded
Determine if the execution of the BuildPipeline succeeded.
Declaration
public bool Succeeded { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
Methods
Failure(BuildPipeline, BuildSettings, String)
Create a new instance of BuildPipelineResult that represent a failed execution.
Declaration
public static BuildPipelineResult Failure(BuildPipeline pipeline, BuildSettings settings, string message)Parameters
| Type | Name | Description |
|---|---|---|
| BuildPipeline | pipeline | |
| BuildSettings | settings | The BuildSettings used throughout this BuildPipeline execution. |
| String | message | The failure message. |
Returns
| Type | Description |
|---|---|
| BuildPipelineResult | A new BuildPipelineResult instance. |
LogResult()
Output the log result to developer debug console.
Declaration
public void LogResult()Success(BuildPipeline, BuildSettings)
Create a new instance of BuildPipelineResult that represent a successful execution.
Declaration
public static BuildPipelineResult Success(BuildPipeline pipeline, BuildSettings settings)Parameters
| Type | Name | Description |
|---|---|---|
| BuildPipeline | pipeline | |
| BuildSettings | settings | The BuildSettings used throughout this BuildPipeline execution. |
Returns
| Type | Description |
|---|---|
| BuildPipelineResult | A new BuildPipelineResult instance. |
ToString()
Get the BuildPipelineResult as a string that can be used for logging.
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| String | The BuildPipelineResult as a string. |
Overrides
TryGetBuildStepResult(IBuildStep, out BuildStepResult)
Get the BuildStepResult for the specified IBuildStep.
Declaration
public bool TryGetBuildStepResult(IBuildStep buildStep, out BuildStepResult value)Parameters
| Type | Name | Description |
|---|---|---|
| IBuildStep | buildStep | The build step to search for the result. |
| BuildStepResult | value | The BuildStepResult if found, otherwise default(BuildStepResult) |
Returns
| Type | Description |
|---|---|
| Boolean | true if the IBuildStep was found, otherwise false. |
Operators
Implicit(BuildPipelineResult to Boolean)
Implicit conversion to Boolean.
Declaration
public static implicit operator bool (BuildPipelineResult result)Parameters
| Type | Name | Description |
|---|---|---|
| BuildPipelineResult | result | Instance of BuildPipelineResult. |
Returns
| Type | Description |
|---|---|
| Boolean |
Implicit(BuildPipelineResult to BuildStepResult)
Implicit conversion to BuildStepResult.
Declaration
public static implicit operator BuildStepResult(BuildPipelineResult result)Parameters
| Type | Name | Description |
|---|---|---|
| BuildPipelineResult | result | Instance of BuildPipelineResult. |
Returns
| Type | Description |
|---|---|
| BuildStepResult |