BambooPlanInfo Class

Summary

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

Syntax

public sealed class BambooPlanInfo : BambooInfo

Constructors

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

Properties

Name Value Summary
PlanKey string
Gets the key of the current plan, in the form PROJECT-PLAN, e.g. BAM-MAIN.
PlanName string
Gets the Bamboo Plan Name.
ShortJobKey string
Gets the Bamboo short job key.
ShortJobName string
Gets the Bamboo short Job Name.
ShortPlanKey string
Gets the Bamboo short Plan Key.
ShortPlanName string
Gets the Bamboo short Plan Name.

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<BambooPlanInfo>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<BambooPlanInfo>(BambooPlanInfo[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<BambooPlanInfo>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<BambooPlanInfo>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<BambooPlanInfo>(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<BambooPlanInfo>(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
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin