BambooBuildInfo Class

Summary

Provides Bamboo build information for a current build.
Namespace
Cake.Common.Build.Bamboo.Data
Base Types
graph BT Type-->Base0["BambooInfo"] click Base0 "/api/Cake.Common.Build.Bamboo/BambooInfo" Base0-->Base1["object"] Type["BambooBuildInfo"] class Type type-node

Syntax

public sealed class BambooBuildInfo : BambooInfo

Constructors

Name Summary
BambooBuildInfo(ICakeEnvironment) Initializes a new instance of the BambooBuildInfo class.

Properties

Name Value Summary
BuildKey string
Gets the job key for the current job, in the form PROJECT-PLAN-JOB, e.g. BAM-MAIN-JOBX.
BuildTimestamp string
Gets the time when build was started in ISO 8601 format e.g. 2010-01-01T01:00:00.000+01:00.
CustomBuild BambooCustomBuildInfo
Gets Bamboo custom build information.
Folder string
Gets the path to the clone directory.
Number int
Gets the build number.
ResultKey string
Gets the Bamboo Build Result Key. The result key when this job executes, in the form PROJECT-PLAN-JOB-BUILD e.g. BAM-BOO-JOB1-8, where '8' is the build number. For deployment projects this variable will not have the JOB component e.g. PROJ-TP-6.
ResultsUrl string
Gets the URL of the result in Bamboo once the job has finished executing.

Methods

Name Value Summary
GetEnvironmentBoolean(string) bool
Gets an environment variable as a bool.
Inherited from BambooInfo
GetEnvironmentInteger(string) int
Gets an environment variable as a int.
Inherited from BambooInfo
GetEnvironmentString(string) string
Gets an environment variable as a string.
Inherited from BambooInfo

Extension Methods

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