GoCDEnvironmentInfo Class

Summary

Provides Go.CD environment information for a current build.
Namespace
Cake.Common.Build.GoCD.Data
Base Types
graph BT Type-->Base0["GoCDInfo"] click Base0 "/api/Cake.Common.Build.GoCD/GoCDInfo" Base0-->Base1["object"] Type["GoCDEnvironmentInfo"] class Type type-node

Syntax

public sealed class GoCDEnvironmentInfo : GoCDInfo

Constructors

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

Properties

Name Value Summary
EnvironmentName string
Gets the environment name. This is only set if the environment is specified. Otherwise the variable is not set.
GoCDUrl string
Gets the Go.CD URL.
JobName string
Gets the name of the current job being run.
Pipeline GoCDPipelineInfo
Gets GoCD pipeline information.
Repository GoCDRepositoryInfo
Gets GoCD repository information.
Stage GoCDStageInfo
Gets GoCD stage information.
User string
Gets the username of the user that triggered the build. This will have one of three possible values: anonymous - if there is no security. username of the user, who triggered the build. changes, if SCM changes auto-triggered the build. timer, if the pipeline is triggered at a scheduled time.

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