Class BuildPipelineResult

Holds the results of the execution of a BuildPipeline.

Inheritance
Object
ResultBase
BuildPipelineResult
Inherited Members
Namespace: Unity.Build
Syntax
public sealed class BuildPipelineResult : ResultBase

Constructors

BuildPipelineResult()

Declaration
public BuildPipelineResult()

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

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>

Methods

Failure(BuildPipeline, BuildConfiguration, Exception)

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

Declaration
public static BuildPipelineResult Failure(BuildPipeline pipeline, BuildConfiguration config, Exception exception)
Parameters
Type Name Description
BuildPipeline pipeline
BuildConfiguration config

The BuildConfiguration used throughout this BuildPipeline execution.
Exception exception
Returns
Type Description
BuildPipelineResult

A new BuildPipelineResult instance.

Failure(BuildPipeline, BuildConfiguration, String)

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

Declaration
public static BuildPipelineResult Failure(BuildPipeline pipeline, BuildConfiguration config, string message)
Parameters
Type Name Description
BuildPipeline pipeline
BuildConfiguration config

The BuildConfiguration used throughout this BuildPipeline execution.
String message

The failure message.
Returns
Type Description
BuildPipelineResult

A new BuildPipelineResult instance.

Success(BuildPipeline, BuildConfiguration)

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

Declaration
public static BuildPipelineResult Success(BuildPipeline pipeline, BuildConfiguration config)
Parameters
Type Name Description
BuildPipeline pipeline
BuildConfiguration config

The BuildConfiguration used throughout this BuildPipeline execution.
Returns
Type Description
BuildPipelineResult

A new BuildPipelineResult instance.

ToString()

Declaration
public override string ToString()
Returns
Type Description
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