GoCDInfo Class

Summary

Base class used to provide information about the Go.CD environment.
Namespace
Cake.Common.Build.GoCD
Base Types
  • object
Derived Types
graph BT Type-->Base0["object"] Type["GoCDInfo"] class Type type-node Derived0["GoCDPipelineInfo"]-->Type click Derived0 "/api/Cake.Common.Build.GoCD.Data/GoCDPipelineInfo" Derived1["GoCDStageInfo"]-->Type click Derived1 "/api/Cake.Common.Build.GoCD.Data/GoCDStageInfo" Derived2["GoCDRepositoryInfo"]-->Type click Derived2 "/api/Cake.Common.Build.GoCD.Data/GoCDRepositoryInfo" Derived3["GoCDEnvironmentInfo"]-->Type click Derived3 "/api/Cake.Common.Build.GoCD.Data/GoCDEnvironmentInfo"

Syntax

public abstract class GoCDInfo

Constructors

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

Methods

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

Extension Methods

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