TFBuildInfo Class

Summary

Provides TF Build info 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["TFBuildInfo"] class Type type-node

Syntax

public sealed class TFBuildInfo : TFInfo

Constructors

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

Properties

Name Value Summary
AccessToken string
Gets the a special variable that carries the security token used by the running build
ArtifactStagingDirectory FilePath
Gets the local path on the agent where any artifacts are copied to before being pushed to their destination
BinariesDirectory FilePath
Gets the local path on the agent you can use as an output folder for compiled binaries
Debug bool
Gets a value indicating whether more detailed logs to debug pipeline problems is enabled
Id int
Gets the ID of the record for the completed build.
Number string
Gets the name of the completed build.
QueuedBy string
Gets the user who queued the build.
Reason string
Gets the event that caused the build to run
RequestedFor string
Gets the user the build was requested for.
RequestedForEmail string
Gets the email of the user the build was requested for.
SourcesDirectory FilePath
Gets the local path on the agent where your source code files are downloaded
StagingDirectory FilePath
Gets the local path on the agent where any artifacts are copied to before being pushed to their destination
TestResultsDirectory FilePath
Gets local path on the agent where the test results are created
TriggeredBy TFBuildTriggeredBy
Gets TF Build TriggeredBy information.
Uri Uri
Gets the URI for the build.

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