TFBuildEnvironmentInfo Class

Summary

Provides TF Build Environment information for the current build.
Namespace
Cake.Common.Build.TFBuild.Data
Base Types
graph BT Type-->Base0["TFInfo"] click Base0 "/api/Cake.Common.Build.TFBuild/TFInfo" Base0-->Base1["object"] Type["TFBuildEnvironmentInfo"] class Type type-node

Syntax

public sealed class TFBuildEnvironmentInfo : TFInfo

Constructors

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

Properties

Name Value Summary
Agent TFBuildAgentInfo
Gets TF Build agent information.
Build TFBuildInfo
Gets TF Build information.
BuildDefinition TFBuildDefinitionInfo
Gets TF Build Definition information.
PullRequest TFBuildPullRequestInfo
Gets TF Build pull request information.
Repository TFBuildRepositoryInfo
Gets TF Build repository information
TeamProject TFBuildTeamProjectInfo
Gets TF Team Project information.

Methods

Name Value Summary
GetEnvironmentBoolean(string) bool
Gets an environment variable as a bool.
Inherited from TFInfo
GetEnvironmentInteger(string) int
Gets an environment variable as a int.
Inherited from TFInfo
GetEnvironmentString(string) string
Gets an environment variable as a string.
Inherited from TFInfo
GetEnvironmentUri(string) Uri
Gets an environment variable as a System.Uri.
Inherited from TFInfo
GetRepositoryType(string) TFRepositoryType?
Gets the current repository type as a TFRepositoryType from an environment variable.
Inherited from TFInfo

Extension Methods

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