GoCDStageInfo Class

Summary

Provides Go.CD commit information for a current build.
Namespace
Cake.Common.Build.GoCD.Data
Base Types
graph BT Type-->Base0["GoCDInfo"] click Base0 "/api/Cake.Common.Build.GoCD/GoCDInfo" Base0-->Base1["object"] Type["GoCDStageInfo"] class Type type-node

Syntax

public sealed class GoCDStageInfo : GoCDInfo

Constructors

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

Properties

Name Value Summary
Counter int
Gets the count of the number of times the current stage has been run.
Name string
Gets the name of the current stage being run.

Methods

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

Extension Methods

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