ContinuaCIInfo Class

Summary

Base class used to provide information about the Continua CI environment.
Namespace
Cake.Common.Build.ContinuaCI
Base Types
  • object
Derived Types
graph BT Type-->Base0["object"] Type["ContinuaCIInfo"] class Type type-node Derived0["ContinuaCIBuildInfo"]-->Type click Derived0 "/api/Cake.Common.Build.ContinuaCI.Data/ContinuaCIBuildInfo" Derived1["ContinuaCIProjectInfo"]-->Type click Derived1 "/api/Cake.Common.Build.ContinuaCI.Data/ContinuaCIProjectInfo" Derived2["ContinuaCIEnvironmentInfo"]-->Type click Derived2 "/api/Cake.Common.Build.ContinuaCI.Data/ContinuaCIEnvironmentInfo" Derived3["ContinuaCIChangesetInfo"]-->Type click Derived3 "/api/Cake.Common.Build.ContinuaCI.Data/ContinuaCIChangesetInfo" Derived4["ContinuaCIConfigurationInfo"]-->Type click Derived4 "/api/Cake.Common.Build.ContinuaCI.Data/ContinuaCIConfigurationInfo"

Syntax

public abstract class ContinuaCIInfo

Constructors

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

Methods

Name Value Summary
GetEnvironmentBoolean(string) bool
Gets an environment variable as a bool.
GetEnvironmentDateTime(string) DateTime?
Gets an environment variable as a DateTime.
GetEnvironmentInteger(string) int
Gets an environment variable as a int.
GetEnvironmentLong(string) long
Gets an environment variable as a long.
GetEnvironmentString(string) string
Gets an environment variable as a string.
GetEnvironmentStringDictionary(string) IDictionary<string, string>
Gets matching list of environment variables as an dictionary of string.
GetEnvironmentStringList(string) IEnumerable<string>
Gets an environment variable as an array of string.
GetEnvironmentTimeSpan(string) TimeSpan?
Gets an environment variable as a TimeSpan.

Extension Methods

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