ContinuaCIEnvironmentInfo Class

Summary

Provides Continua CI environment information for a current build.
Namespace
Cake.Common.Build.ContinuaCI.Data
Base Types
graph BT Type-->Base0["ContinuaCIInfo"] click Base0 "/api/Cake.Common.Build.ContinuaCI/ContinuaCIInfo" Base0-->Base1["object"] Type["ContinuaCIEnvironmentInfo"] class Type type-node

Syntax

public sealed class ContinuaCIEnvironmentInfo : ContinuaCIInfo

Constructors

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

Properties

Name Value Summary
AgentProperty IDictionary<string, string>
Gets Continua CI build agent properties.
Build ContinuaCIBuildInfo
Gets Continua CI build information.
Configuration ContinuaCIConfigurationInfo
Gets Continua CI configuration information.
Project ContinuaCIProjectInfo
Gets Continua CI project information.
Variable IDictionary<string, string>
Gets Continua CI build variables.
Version string
Gets Continua CI product version.

Methods

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

Extension Methods

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