RwxEnvironmentInfo Class

Summary

Provides RWX environment information for the current build.
Namespace
Cake.Common.Build.Rwx.Data
Base Types
graph BT Type-->Base0["RwxInfo"] click Base0 "/api/Cake.Common.Build.Rwx/RwxInfo" Base0-->Base1["object"] Type["RwxEnvironmentInfo"] class Type type-node

Syntax

public sealed class RwxEnvironmentInfo : RwxInfo

Constructors

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

Properties

Name Value Summary
Actor RwxActorInfo
Gets RWX actor information for the current build.
CI bool
Gets a value indicating whether the current build is continuous integration.
Git RwxGitInfo
Gets RWX git information for the current build.
Run RwxRunInfo
Gets RWX run information for the current build.
Runtime RwxRuntimeInfo
Gets RWX runtime information for the current build. Exposes the filesystem locations RWX uses for runtime-written output values and artifacts. Available inside any task running on RWX.
Rwx bool
Gets a value indicating whether the environment is RWX.
Task RwxTaskInfo
Gets RWX task information for the current build.

Methods

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

Extension Methods

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