JenkinsNodeInfo Class

Summary

Provides Jenkins node 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["JenkinsNodeInfo"] class Type type-node

Syntax

public class JenkinsNodeInfo : JenkinsInfo

Constructors

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

Properties

Name Value Summary
NodeLabels string[]
Gets the node labels.
NodeName string
Gets the name of the node.

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