JenkinsEnvironmentInfo Class

Summary

Provides Jenkins environment information for the current build.
Namespace
Cake.Common.Build.Jenkins.Data
Base Types
graph BT Type-->Base0["JenkinsInfo"] click Base0 "/api/Cake.Common.Build.Jenkins/JenkinsInfo" Base0-->Base1["object"] Type["JenkinsEnvironmentInfo"] class Type type-node

Syntax

public sealed class JenkinsEnvironmentInfo : JenkinsInfo

Constructors

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

Properties

Name Value Summary
Build JenkinsBuildInfo
Gets Jenkins build information.
Change JenkinsChangeInfo
Gets the change.
JenkinsHome string
Gets the absolute path of the directory assigned on the master node for Jenkins to store data.
JenkinsUrl string
Gets the full URL of Jenkins (note: only available if Jenkins URL is set in system configuration).
Job JenkinsJobInfo
Gets Jenkins job information.
Node JenkinsNodeInfo
Gets the node.
Repository JenkinsRepositoryInfo
Gets Jenkins repository information.

Methods

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

Extension Methods

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