BambooInfo Class

Summary

Base class used to provide information about the Bamboo environment.
graph BT Type-->Base0["object"] Type["BambooInfo"] class Type type-node Derived0["BambooPlanInfo"]-->Type click Derived0 "/api/Cake.Common.Build.Bamboo.Data/BambooPlanInfo" Derived1["BambooBuildInfo"]-->Type click Derived1 "/api/Cake.Common.Build.Bamboo.Data/BambooBuildInfo" Derived2["BambooEnvironmentInfo"]-->Type click Derived2 "/api/Cake.Common.Build.Bamboo.Data/BambooEnvironmentInfo" Derived3["BambooCommitInfo"]-->Type click Derived3 "/api/Cake.Common.Build.Bamboo.Data/BambooCommitInfo" Derived4["BambooCustomBuildInfo"]-->Type click Derived4 "/api/Cake.Common.Build.Bamboo.Data/BambooCustomBuildInfo" Derived5["BambooRepositoryInfo"]-->Type click Derived5 "/api/Cake.Common.Build.Bamboo.Data/BambooRepositoryInfo"

Syntax

public abstract class BambooInfo

Constructors

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

Methods

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

Extension Methods

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