GitLabCIInfo Class

Summary

Base class used to provide information about the GitLab CI environment.
Namespace
Cake.Common.Build.GitLabCI
Base Types
  • object
Derived Types
graph BT Type-->Base0["object"] Type["GitLabCIInfo"] class Type type-node Derived0["GitLabCIBuildInfo"]-->Type click Derived0 "/api/Cake.Common.Build.GitLabCI.Data/GitLabCIBuildInfo" Derived1["GitLabCIPullRequestInfo"]-->Type click Derived1 "/api/Cake.Common.Build.GitLabCI.Data/GitLabCIPullRequestInfo" Derived2["GitLabCIProjectInfo"]-->Type click Derived2 "/api/Cake.Common.Build.GitLabCI.Data/GitLabCIProjectInfo" Derived3["GitLabCIServerInfo"]-->Type click Derived3 "/api/Cake.Common.Build.GitLabCI.Data/GitLabCIServerInfo" Derived4["GitLabCIRunnerInfo"]-->Type click Derived4 "/api/Cake.Common.Build.GitLabCI.Data/GitLabCIRunnerInfo" Derived5["GitLabCIEnvironmentInfo"]-->Type click Derived5 "/api/Cake.Common.Build.GitLabCI.Data/GitLabCIEnvironmentInfo"

Syntax

public abstract class GitLabCIInfo

Constructors

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

Methods

Name Value Summary
GetEnvironmentBoolean(string, string) bool
Gets an environment variable as a bool.
GetEnvironmentBoolean(string) bool
Gets an environment variable as a bool.
GetEnvironmentEnum<TEnum>(string) TEnum?
Gets an environment variable as an enum.
GetEnvironmentInteger(string, string) int
Gets an environment variable as a int.
GetEnvironmentInteger(string) int
Gets an environment variable as a int.
GetEnvironmentString(string, string) string
Gets an environment variable as a string.
GetEnvironmentString(string) string
Gets an environment variable as a string.

Extension Methods

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