TeamCityBuildInfo Class

Summary

Provides TeamCity build information for a 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["TeamCityBuildInfo"] class Type type-node

Syntax

public class TeamCityBuildInfo : TeamCityInfo

Constructors

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

Properties

Name Value Summary
BranchName string
Gets the branch display name.
BuildConfName string
Gets the build configuration name.
BuildProperties Dictionary<string, string>
Gets the TeamCity build properties.
ConfigProperties Dictionary<string, string>
Gets the TeamCity config properties.
Number string
Gets the build number.
RunnerProperties Dictionary<string, string>
Gets the TeamCity runner properties.
StartDateTime DateTimeOffset?
Gets the build start date and time.
VcsBranchName string
Gets the vcs branch name.

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