TFBuildTriggeredBy Class

Summary

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

Syntax

public class TFBuildTriggeredBy : TFInfo

Remarks

Only populated if the build was triggered by another build

Constructors

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

Properties

Name Value Summary
BuildId int
Gets the BuildID of the triggering build
BuildNumber string
Gets the number of the triggering build
DefinitionId int
Gets the DefinitionID of the triggering build
DefinitionName string
Gets the name of the triggering build pipeline
ProjectId string
Gets the ID of the project that contains the triggering 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<TFBuildTriggeredBy>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<TFBuildTriggeredBy>(TFBuildTriggeredBy[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<TFBuildTriggeredBy>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<TFBuildTriggeredBy>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<TFBuildTriggeredBy>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<TFBuildTriggeredBy>(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