JenkinsInfo Class

Summary

Base class used to provide information about the Jenkins environment.
Namespace
Cake.Common.Build.Jenkins
Base Types
  • object
Derived Types
graph BT Type-->Base0["object"] Type["JenkinsInfo"] class Type type-node Derived0["JenkinsNodeInfo"]-->Type click Derived0 "/api/Cake.Common.Build.Jenkins.Data/JenkinsNodeInfo" Derived1["JenkinsJobInfo"]-->Type click Derived1 "/api/Cake.Common.Build.Jenkins.Data/JenkinsJobInfo" Derived2["JenkinsBuildInfo"]-->Type click Derived2 "/api/Cake.Common.Build.Jenkins.Data/JenkinsBuildInfo" Derived3["JenkinsEnvironmentInfo"]-->Type click Derived3 "/api/Cake.Common.Build.Jenkins.Data/JenkinsEnvironmentInfo" Derived4["JenkinsRepositoryInfo"]-->Type click Derived4 "/api/Cake.Common.Build.Jenkins.Data/JenkinsRepositoryInfo" Derived5["JenkinsChangeInfo"]-->Type click Derived5 "/api/Cake.Common.Build.Jenkins.Data/JenkinsChangeInfo"

Syntax

public abstract class JenkinsInfo

Constructors

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