AzureDevOpsBuild Class

Summary

Class for writing issues to Azure DevOps pull requests.
Assembly
Cake.AzureDevOps.dll
Namespace
Cake.AzureDevOps.Pipelines
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["AzureDevOpsBuild"] class Type type-node

Syntax

public sealed class AzureDevOpsBuild

Constructors

Name Summary
AzureDevOpsBuild(ICakeLog, AzureDevOpsBuildSettings) Initializes a new instance of the AzureDevOpsBuild class.

Properties

Name Value Summary
BuildId int
Gets the ID of the build. Returns 0 if no build could be found and ThrowExceptionIfBuildCouldNotBeFound is set to false.
CollectionUrl Uri
Gets the URL for accessing the web portal of the Azure DevOps collection.
FinishTime Nullable<DateTime>
Gets the finish time of the build. Returns null if no build could be found and ThrowExceptionIfBuildCouldNotBeFound is set to false.
HasBuildLoaded bool
Gets a value indicating whether a build has been successfully loaded.
Parameters IDictionary<string, string>
Gets the parameters passed to the build. Returns an empty dictionary if no build could be found and ThrowExceptionIfBuildCouldNotBeFound is set to false.
ProjectId Guid
Gets the id of the Azure DevOps project. Returns System.Guid.Empty if no build could be found and ThrowExceptionIfBuildCouldNotBeFound is set to false.
ProjectName string
Gets the name of the Azure DevOps project. Returns empty string if no build could be found and ThrowExceptionIfBuildCouldNotBeFound is set to false.
RepositoryId Guid
Gets the ID of the repository. Returns System.Guid.Empty if no build could be found and ThrowExceptionIfBuildCouldNotBeFound is set to false.
RepositoryName string
Gets the name of the Git repository. Returns System.String.Empty if no build could be found and ThrowExceptionIfBuildCouldNotBeFound is set to false.
Result Nullable<AzureDevOpsBuildResult>
Gets the result of the build. Returns 0 if no build could be found and ThrowExceptionIfBuildCouldNotBeFound is set to false.
Status Nullable<AzureDevOpsBuildStatus>
Gets the status of the build. Returns 0 if no build could be found and ThrowExceptionIfBuildCouldNotBeFound is set to false.

Methods

Name Value Summary
GetArtifacts() IEnumerable<AzureDevOpsBuildArtifact>
Gets the artifacts associated with a build.
GetChanges() IEnumerable<AzureDevOpsChange>
Gets the changes associated with a build.
GetTestRuns() IEnumerable<AzureDevOpsTestRun>
Gets the test runs of the build including test results.
GetTestRuns(Nullable<int>) IEnumerable<AzureDevOpsTestRun>
Gets the test runs of the build including test results.
GetTimelineRecords() IEnumerable<AzureDevOpsTimelineRecord>
Gets the timeline entries for a build.
IsBuildFailing() bool
Checks if the build is failing.
LinkArtifact(string, string, string) AzureDevOpsBuildArtifact
Create an artifact link, such as a file or folder path or a version control path.

Extension Methods

Name Value Summary
Dump<AzureDevOpsBuild>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<AzureDevOpsBuild>(AzureDevOpsBuild[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<AzureDevOpsBuild>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<AzureDevOpsBuild>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<AzureDevOpsBuild>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<AzureDevOpsBuild>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin