TeamCityEnvironmentInfo Class

Summary

Provides TeamCity environment information for current build.
Namespace
Cake.Common.Build.TeamCity.Data
Base Types
graph BT Type-->Base0["TeamCityInfo"] click Base0 "/api/Cake.Common.Build.TeamCity/TeamCityInfo" Base0-->Base1["object"] Type["TeamCityEnvironmentInfo"] class Type type-node

Syntax

public class TeamCityEnvironmentInfo : TeamCityInfo

Constructors

Name Summary
TeamCityEnvironmentInfo(ICakeEnvironment, IFileSystem) Initializes a new instance of the TeamCityEnvironmentInfo class.

Properties

Name Value Summary
Build TeamCityBuildInfo
Gets TeamCity build information.
Project TeamCityProjectInfo
Gets TeamCity project information.
PullRequest TeamCityPullRequestInfo
Gets TeamCity pull-request information.

Methods

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

Extension Methods

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