GitLabCIEnvironmentInfo Class

Summary

Provides GitLab CI environment information for a current build.
Namespace
Cake.Common.Build.GitLabCI.Data
Base Types
graph BT Type-->Base0["GitLabCIInfo"] click Base0 "/api/Cake.Common.Build.GitLabCI/GitLabCIInfo" Base0-->Base1["object"] Type["GitLabCIEnvironmentInfo"] class Type type-node

Syntax

public sealed class GitLabCIEnvironmentInfo : GitLabCIInfo

Constructors

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

Properties

Name Value Summary
Build GitLabCIBuildInfo
Gets the GitLab CI build information.
Project GitLabCIProjectInfo
Gets the GitLab CI project information.
PullRequest GitLabCIPullRequestInfo
Gets GitLab CI pull request information.
Runner GitLabCIRunnerInfo
Gets the GitLab CI runner information.
Server GitLabCIServerInfo
Gets the GitLab CI server information.

Methods

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

Extension Methods

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