BambooEnvironmentInfo Class

Summary

Provides Bamboo environment 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["BambooEnvironmentInfo"] class Type type-node

Syntax

public sealed class BambooEnvironmentInfo : BambooInfo

Constructors

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

Properties

Name Value Summary
Build BambooBuildInfo
Gets Bamboo build information.
Plan BambooPlanInfo
Gets Bamboo plan information.
Repository BambooRepositoryInfo
Gets Bamboo repository information.

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