GoCDProvider Class

Summary

Responsible for communicating with GoCD.

Namespace

Cake.Common.Build.GoCD

Interfaces

IGoCDProvider

Base Types

object

graph BT Type-->Base0["object"] Type-.->Interface0["IGoCDProvider"] click Interface0 "/api/Cake.Common.Build.GoCD/IGoCDProvider" Type["GoCDProvider"] class Type type-node

Syntax

public sealed class GoCDProvider : IGoCDProvider

Constructors

Name	Summary
GoCDProvider(ICakeEnvironment, ICakeLog)	Initializes a new instance of the `GoCDProvider` class.

Properties

Name	Value	Summary
Environment	GoCDEnvironmentInfo	Gets the Go.CD environment.
IsRunningOnGoCD	bool	Gets a value indicating whether the current build is running on Go.CD.

Methods

Name	Value	Summary
GetHistory(string, string, string)	GoCDHistoryInfo	Gets the Go.CD build history, including the repository modifications that caused the pipeline to start.
GetHistory(string, string)	GoCDHistoryInfo	Gets the Go.CD build history, including the repository modifications that caused the pipeline to start.

Extension Methods

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