GoCDPipelineInfo Class

Summary

Provides GoCD pipeline information for a current build.

Namespace

Cake.Common.Build.GoCD.Data

Base Types

object
GoCDInfo

graph BT Type-->Base0["GoCDInfo"] click Base0 "/api/Cake.Common.Build.GoCD/GoCDInfo" Base0-->Base1["object"] Type["GoCDPipelineInfo"] class Type type-node

Syntax

public sealed class GoCDPipelineInfo : GoCDInfo

Constructors

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

Properties

Name	Value	Summary
Counter	int	Gets the pipeline counter, showing how many times the current pipeline has been run.
Label	string	Gets the pipeline label. By default, this is set to the pipeline count.
Name	string	Gets the name of the pipeline.

Methods

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

Extension Methods

Name	Value	Summary
Dump<GoCDPipelineInfo>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<GoCDPipelineInfo>(GoCDPipelineInfo[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<GoCDPipelineInfo>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<GoCDPipelineInfo>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<GoCDPipelineInfo>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<GoCDPipelineInfo>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin