JenkinsJobInfo Class

Summary

Provides Jenkins job information for a 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["JenkinsJobInfo"] class Type type-node

Syntax

public class JenkinsJobInfo : JenkinsInfo

Constructors

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

Properties

Name Value Summary
JobBaseName string
Gets the short name of the project of this build stripping off folder paths, such as "foo" for "bar/foo".
JobName string
Gets the name of the job.
JobUrl string
Gets the URL of the job.

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