OctopusDeployTool<TSettings> Class

Summary

Base class for all octopus deploy related tools.
Namespace
Cake.Common.Tools.OctopusDeploy
Base Types
Derived Types
graph BT Type-->Base0["Tool<TSettings>"] Base0-->Base1["object"] Type["OctopusDeployTool<TSettings>"] class Type type-node Derived0["OctopusDeployReleaseDeployer"]-->Type click Derived0 "/api/Cake.Common.Tools.OctopusDeploy/OctopusDeployReleaseDeployer" Derived1["OctopusDeployReleaseCreator"]-->Type click Derived1 "/api/Cake.Common.Tools.OctopusDeploy/OctopusDeployReleaseCreator" Derived2["OctopusDeployReleasePromoter"]-->Type click Derived2 "/api/Cake.Common.Tools.OctopusDeploy/OctopusDeployReleasePromoter" Derived3["OctopusDeployPusher"]-->Type click Derived3 "/api/Cake.Common.Tools.OctopusDeploy/OctopusDeployPusher" Derived4["OctopusDeployDeploymentQuerier"]-->Type click Derived4 "/api/Cake.Common.Tools.OctopusDeploy/OctopusDeployDeploymentQuerier" Derived5["OctopusDeployPacker"]-->Type click Derived5 "/api/Cake.Common.Tools.OctopusDeploy/OctopusDeployPacker"

Syntax

public class OctopusDeployTool<TSettings> : Tool<TSettings> 
    where TSettings : OctopusDeployToolSettings

Type Parameters

Name Description
TSettings The settings type.

Constructors

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

Properties

Name Value Summary
Environment ICakeEnvironment
Gets the environment.

Methods

Name Value Summary
GetToolExecutableNames() IEnumerable<string>
Gets the possible names of the tool executable.
GetToolName() string
Gets the name of the tool.

Extension Methods

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