OpenshiftTool<TSettings> Class

Summary

Base class for all Openshift related tools.
Assembly
Cake.Openshift.dll
Namespace
Cake.Openshift
Base Types
Derived Types
graph BT Type-->Base0["Tool<TSettings>"] Type["OpenshiftTool<TSettings>"] class Type type-node Derived0["OpenshiftLoginner"]-->Type click Derived0 "/api/Cake.Openshift.Login/OpenshiftLoginner" Derived1["OpenshiftBuildStarter"]-->Type click Derived1 "/api/Cake.Openshift.StartBuild/OpenshiftBuildStarter" Derived2["OpenshiftDeleter"]-->Type click Derived2 "/api/Cake.Openshift.Delete/OpenshiftDeleter"

Syntax

public abstract class OpenshiftTool<TSettings> : Tool<TSettings> where TSettings : OpenshiftSettings

Type Parameters

Name Description
TSettings The settings type.

Constructors

Name Summary
OpenshiftTool(IFileSystem, ICakeEnvironment, IProcessRunner, IToolLocator) Initializes a new instance of the OpenshiftTool<TSettings> class.

Methods

Name Value Summary
GetToolExecutableNames() IEnumerable<string>
Gets the possible names of the tool executable.
GetToolName() string
Gets the name of the tool.
RunCommand(TSettings, ProcessArgumentBuilder) void
Runs the openshift cli command using the specified settings and arguments.

Extension Methods

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